Payout

Account Details

GET {{baseUrl}}/api/v2/client/payout/account_details

Response

Ok (200)

{
    "data": [
        {
            "walletProviderId": 5,
            "accountNumber": "9038299384",
            "accountName": "OLUWADAMILOLA OGUNLUSI",
            "globalAccountNumber": "9038299384-5",
            "clientId": 31,
            "accountBalance": 7895876.531765,
            "availableBalance": 7895876.531765,
            "isPrimaryAccount": true,
            "currencyCode": "NGN"
        }
    ],
    "message": "Success",
    "status": true,
    "status_code": 200
}

Bad Request (400)

{
    "message": "No account setup yet.",
    "status": false,
    "status_code": 400
}

Financial Institutions

GET {{baseUrl}}/api/v2/client/payout/financial_institutions

Response

{
    "message": "Success",
    "status": true,
    "status_code": 200,
    "data": [
        {
            "bank_code": "999461",
            "bank_name": "Advancly MFB",
            "png_logo_url": null,
            "svg_logo_url": null
        },
        {
            "bank_code": "120001",
            "bank_name": "9 payment service Bank",
            "png_logo_url": null,
            "svg_logo_url": null
        },
        {
            "bank_code": "090270",
            "bank_name": "AB MICROFINANCE BANK",
            "png_logo_url": null,
            "svg_logo_url": null
        },
        {
            "bank_code": "070010",
            "bank_name": "ABBEY MORTGAGE BANK",
            "png_logo_url": "",
            "svg_logo_url": ""
        },
        {
            "bank_code": "090260",
            "bank_name": "ABOVE ONLY MICROFINANCE BANK",
            "png_logo_url": "",
            "svg_logo_url": ""
        },
        {
            "bank_code": "090197",
            "bank_name": "ABU MICROFINANCE BANK",
            "png_logo_url": null,
            "svg_logo_url": null
        }
    ]
}

Name Enquiry

GET {{baseUrl}}/api/v2/client/payout/name_enquiry?account_number=9038299384&bank_code=999461

Query Parameters

Name

Type

Description

account_number

string

bank account number

bank_code

string

nibss bank code

Response

{
    "data": {
        "account_number": "9038299384",
        "account_name": "OLUWADAMILOLA OGUNLUSI",
        "kyc_tier": "3",
        "bvn": "2209309****"
    },
    "message": "Success",
    "status": true,
    "status_code": 200
}

Payout

POST {{baseUrl}}/api/v2/client/payout/payout

Sample Request & Fields Details

{
    "sender_account_number": "9038299384",
    "recipient_account_number": "7037662603",
    "recipient_account_name": "PAUL IKHIDE",
    "recipient_bank_code": "999461",
    "amount": 1200,
    "narration": "Glorious test battle",
    "reference": "Advancly-HAUUSIKSNJWUWJSN61728829289"
}

Name

Type

Description

sender_account_number

string

account number of the transfer initiator

recipient_account_number

string

account number of the transfer recipient

recipient_account_name

string

bank account name retrieved from a name inquiry

recipient_bank_code

string

NIBSS bank code of the receiving bank

amount

number

transfer amount

narration

string

transfer narration

reference

string

transaction reference, e.g., (Advancly-J178IND172891JAHSEE)

Response

Ok (200)

{
    "response_code": "00",
    "message": "Successful",
    "status": true,
    "status_code": 200,
    "data": {
        "currency": "NGN",
        "sender_account_name": "OLUWADAMILOLA OGUNLUSI",
        "sender_account_number": "9038299384",
        "sender_bank_code": "999461",
        "sender_bank_name": "Advancly MFB",
        "recipient_account_name": "PAUL IKHIDE",
        "recipient_account_number": "7037662603",
        "recipient_bank_code": "999461",
        "recipient_bank_name": "Advancly MFB",
        "transaction_id": "0",
        "transaction_reference": "Advancly-HAUUSIKSNJWUWJSN61728829289",
        "session_id": null,
        "narration": "Glorious test battle",
        "transaction_status": "Completed",
        "amount": 1200,
        "transaction_charge": 0,
        "transaction_message": "Success",
        "transaction_date": "2025-03-29T23:12:41.646117+01:00"
    }
}

Bad Request (400)

{
    "response_code": "99",
    "message": "Transfer limit exceeded the configured limit of 1000000.",
    "status": false,
    "status_code": 400
}

{
    "response_code": "A102",
    "message": "Duplicate Reference",
    "status": false,
    "status_code": 400
}

TSQ

GET {{baseUrl}}/api/v2/client/payout/transaction/{transactionReference}

Response

Ok (200)

{
    "data": {
        "id": 6,
        "externalReferenceNumber": "Advancly-HAUUSIKSNJWUWJSN617288292814",
        "sessionId": null,
        "senderAccountName": "OLUWADAMILOLA OGUNLUSI",
        "senderAccountNumber": "9038299384",
        "senderBankCode": "999461",
        "senderBankName": "Advancly MFB",
        "recipientAccountName": "PAUL IKHIDE",
        "recipientAccountNumber": "7037662603",
        "recipientBankCode": "999461",
        "recipientBankName": "Advancly MFB",
        "amount": 1200.00,
        "feeCharge": 0.00,
        "narration": "Glorious test battle/Advancly-HAUUSIKSNJWUWJSN617288292814",
        "transactionStatus": "Completed", // Completed, Failed, Processing
        "transactionType": "Outward",
        "responseCode": "00",
        "responseMessage": "Success",
        "channelCode": 9,
        "transactionDate": "2025-04-09T14:59:08.992077",
        "createdDateTime": "2025-04-09T14:59:15.162074"
    },
    "message": "Success",
    "status": true,
    "status_code": 200
}

Bad Request (404)

{
    "message": "Record not found",
    "status": false,
    "status_code": 404
}

Transactions

GET {{baseUrl}}/api/v2/client/payout/transactions?account_number=9038299384&start_date=2025-03-15&end_date=2025-03-21&page=1&page_size=10

Query Parameters

Name

Type

Description

account_number

string

account no

start_date

date (yyyy-mm-dd)

start date of the transaction

end_date

date (yyyy-mm-dd)

end date of the transaction

page

number

page number (default 1)

page_size

number

page size number (default 10)

Response

Ok (200)

{
    "page": 1,
    "pageSize": 10,
    "totalCount": 31,
    "totalPages": 4,
    "message": "Success",
    "status": true,
    "status_code": 200,
    "data": [
        {
            "accountNumber": "9038299384",
            "transactionAmount": 980.000000,
            "balance": 8972888.531765,
            "transactionDate": "2025-03-19T00:00:00",
            "createdDate": "2025-03-19T08:12:33.956629",
            "transactionType": "DEBIT",
            "narration": "Glorious test battle",
            "clientId": 31,
            "currencyCode": "NGN",
            "senderDetails": {
                "name": "OLUWADAMILOLA OGUNLUSI",
                "bankName": "Advancly MFB",
                "accountNumber": "9038299384"
            },
            "receiverDetails": {
                "name": "PAUL IKHIDE",
                "bankName": "Advancly MFB",
                "accountNumber": "7037662603"
            },
            "sessionId": null
        },
        {
            "accountNumber": "9038299384",
            "transactionAmount": 1200.000000,
            "balance": 8971688.531765,
            "transactionDate": "2025-03-19T00:00:00",
            "createdDate": "2025-03-19T08:14:28.131603",
            "transactionType": "DEBIT",
            "narration": "Glorious test battle",
            "clientId": 31,
            "currencyCode": "NGN",
            "senderDetails": {
                "name": "OLUWADAMILOLA OGUNLUSI",
                "bankName": "Advancly MFB",
                "accountNumber": "9038299384"
            },
            "receiverDetails": {
                "name": "PAUL IKHIDE",
                "bankName": "Advancly MFB",
                "accountNumber": "7037662603"
            },
            "sessionId": null
        },
        {
            "accountNumber": "9038299384",
            "transactionAmount": 580.000000,
            "balance": 8971108.531765,
            "transactionDate": "2025-03-19T00:00:00",
            "createdDate": "2025-03-19T08:17:50.657354",
            "transactionType": "DEBIT",
            "narration": "Glorious test battle",
            "clientId": 31,
            "currencyCode": "NGN",
            "senderDetails": {
                "name": "OLUWADAMILOLA OGUNLUSI",
                "bankName": "Advancly MFB",
                "accountNumber": "9038299384"
            },
            "receiverDetails": {
                "name": "PAUL IKHIDE",
                "bankName": "Advancly MFB",
                "accountNumber": "7037662603"
            },
            "sessionId": null
        }
    ]
}

Transaction Response Codes

Code

Description