Logo Logo

Documentation v1.0

Go to Dashboard

Transfers


The Transfers API allows you automate sending money on your integration

Feature Availability

This feature is only available to businesses in Nigeria.

Initiate Transfer

Status of transfer object returned will be pending until it's proccessed successfully.

POST /bank_transfer

Headers

Param Required Description
authorization
string 		Yes Set value to Bearer SECRET_KEY
content-type
string 		Yes Set value to application/json

Body Param

Param Required Description
currency
string 		Yes Specify the currency of the transfer. Defaults to NGN
amount
string 		Yes Amount to transfer in currency SET value
bank_code
string 		Yes receiver's account bank code (check bank list)
bank_name
string 		Yes receiver's account bank name (check bank list)
account_number
string 		Yes receiver's account number
narration
string 		Yes Transfer naration
reference
string 		(Optional) If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters allowed. 
{
    "success": true,
    "message": "Transfer successfully logged and Processing",
    "data": {
        "reference": "trf_11044f068j1604",
        "currency": "NGN",
        "amount": "100",
        "fee": "10",
        "bank_code": "000013",
        "bank_name": "GUARANTY TRUST BANK",
        "account_number": "0050883605",
        "account_name": "OYENIYI TOLULOPE OYEBIYI",
        "narration": "Test transfer",
        "domain": "test",
        "status": "pending",
        "updated_at": "2022-03-29T02:51:01.000000Z",
        "created_at": "2022-03-29T02:51:01.000000Z"
    }
}

curl https://budpay.ng/api/v1/bank_transfer
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{
    "currency": "NGN",
    "amount": "100",
    "bank_code": "000013",
    "bank_name": "GUARANTY TRUST BANK",
    "account_number": "0050883605",
    "narration": "Test transfer"
}'
-X POST

Initiate Bulk Transfer

Status of transfer object returned will be pending until it's proccessed successfully.

POST /bulk_bank_transfer

Headers

Param Required Description
authorization
string 		Yes Set value to Bearer SECRET_KEY
content-type
string 		Yes Set value to application/json

Body Param

Param Required Description
currency
string 		Yes Specify the currency of the transfer. Defaults to NGN
amount
string 		Yes Amount to transfer in currency SET value
bank_code
string 		Yes receiver's account bank code (check bank list)
bank_name
string 		Yes receiver's account bank name (check bank list)
account_number
string 		Yes receiver's account number
narration
string 		Yes Transfer naration
reference
string 		(Optional) If specified, the field should be a unique identifier (in lowercase) for the object. Only -,_ and alphanumeric characters allowed. 
{
    "success": true,
    "message": "3 Transfers queued",
    "data": [
        {
            "reference": "trf_j51m4695fk57nf",
            "currency": "NGN",
            "amount": "200",
            "fee": "10",
            "bank_code": "000013",
            "bank_name": "GUARANTY TRUST BANK",
            "account_number": "0050883605",
            "account_name": "OYENIYI TOLULOPE OYEBIYI",
            "narration": "January Salary",
            "domain": "test",
            "status": "pending",
            "updated_at": "2022-03-30T00:03:12.000000Z",
            "created_at": "2022-03-30T00:03:12.000000Z"
        },
        {
            "reference": "trf_1h1x3v5400n612",
            "currency": "NGN",
            "amount": "100",
            "fee": "10",
            "bank_code": "000013",
            "bank_name": "GUARANTY TRUST BANK",
            "account_number": "0050883605",
            "account_name": "OYENIYI TOLULOPE OYEBIYI",
            "narration": "February  Salary",
            "domain": "test",
            "status": "pending",
            "updated_at": "2022-03-30T00:03:13.000000Z",
            "created_at": "2022-03-30T00:03:13.000000Z"
        },
        {
            "reference": "trf_f9098ac5272653",
            "currency": "NGN",
            "amount": "100",
            "fee": "10",
            "bank_code": "000013",
            "bank_name": "GUARANTY TRUST BANK",
            "account_number": "0050883605",
            "account_name": "OYENIYI TOLULOPE OYEBIYI",
            "narration": "March  Salary",
            "domain": "test",
            "status": "pending",
            "updated_at": "2022-03-30T00:03:13.000000Z",
            "created_at": "2022-03-30T00:03:13.000000Z"
        }
    ]
}

curl https://budpay.ng/api/v1/bulk_bank_transfer
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{
    "currency": "NGN",
    "transfers": [
        {
            "amount": "200",
            "bank_code": "000013",
            "bank_name": "GUARANTY TRUST BANK",
            "account_number": "0050883605",
            "narration": "January Salary"
        },
        {
            "amount": "100",
            "bank_code": "000013",
            "bank_name": "GUARANTY TRUST BANK",
            "account_number": "0050883605",
            "narration": "February  Salary"
        },
        {
            "amount": "100",
            "bank_code": "000013",
            "bank_name": "GUARANTY TRUST BANK",
            "account_number": "0050883605",
            "narration": "March  Salary"
        }
    ]
}'
-X POST

List Transfers

List the transfers made on your integration.

GET /list_transfers

Headers

Param Required Description
authorization
string 		Yes Set value to Bearer SECRET_KEY

Query Param

Param Required Description
currency
string 		Yes search transfers by specific currency 
{
    "status": true,
    "message": "Transfers retrieved",
    "data": [
        {
            "id": 15,
            "reference": "trf_11044f068j1604",
            "sessionid": null,
            "currency": "NGN",
            "amount": "100",
            "fee": "10",
            "bank_code": "000013",
            "bank_name": "GUARANTY TRUST BANK",
            "account_number": "0050883605",
            "account_name": "OYENIYI TOLULOPE OYEBIYI",
            "narration": "Test transfer",
            "domain": "test",
            "status": "pending",
            "subaccount": null,
            "created_at": "2022-03-29T02:51:01.000000Z",
            "updated_at": "2022-03-29T02:51:01.000000Z"
        }
    ],
    "meta": {
        "total": 1
    }
}

curl https://budpay.ng/api/v1/list_transfers
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X GET

Fetch Payout

Fetch a payout record using payout reference.

GET /payout/:reference

Headers

Param Required Description
authorization
string 		Yes Set value to Bearer SECRET_KEY 
{
    "status": true,
    "message": "Payout retrieved",
    "data": {
        "id": 15,
        "reference": "trf_11044f068j1604",
        "sessionid": null,
        "currency": "NGN",
        "amount": "100",
        "fee": "10",
        "bank_code": "000013",
        "bank_name": "GUARANTY TRUST BANK",
        "account_number": "0050883605",
        "account_name": "OYENIYI TOLULOPE OYEBIYI",
        "narration": "Test transfer",
        "domain": "test",
        "status": "pending",
        "subaccount": null,
        "created_at": "2022-03-29T01:51:01.000000Z",
        "updated_at": "2022-03-29T01:51:01.000000Z"
    }
}

curl https://budpay.ng/api/v1/payout/:reference
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X GET

Bank List

Get a list of all supported banks and their codes.

GET /bank_list

Bank Availability

We currently support Wema Bank only.

Headers

Param Required Description
authorization
string 		Yes Set value to Bearer SECRET_KEY 
{
    "success": true,
    "message": "Bank list retrieved",
    "data": [
        {
            "bank_name": "9PAYMENT SERVICE BANK",
            "bank_code": "120001"
        },
        {
            "bank_name": "AB MICROFINANCE BANK",
            "bank_code": "090270"
        },
        {
            "bank_name": "ABBEY MORTGAGE BANK ",
            "bank_code": "070010"
        },
        {
            "bank_name": "ABUCOOP MICROFINANCE BANK",
            "bank_code": "090424"
        },
        {
            "bank_name": "ACCESS BANK",
            "bank_code": "000014"
        },
        ...
        {
            "bank_name": "WEMA BANK",
            "bank_code": "000017"
        },
        {
            "bank_name": "ZENITH BANK",
            "bank_code": "000015"
        }
    ]
}

curl https://budpay.ng/api/v1/bank_list
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X GET

Account Name Verify

Get the account name on an account number.

POST /account_name_verify

Headers

Param Required Description
authorization
string 		Yes Set value to Bearer SECRET_KEY
content-type
string 		Yes Set value to application/json

Body Param

Param Required Description
bank_code
string 		Yes account bank code (check bank list)
account_number
string 		Yes account number 
{
    "success": true,
    "message": "Account name retrieved",
    "data": "OYENIYI TOLULOPE OYEBIYI"
}

curl https://budpay.ng/api/v1/bank_transfer
-H "Authorization: Bearer YOUR_SECRET_KEY"
-H "Content-Type: application/json"
-d '{
    "bank_code": "000013",
    "account_number": "0050883605"
}'
-X POST

Check Wallet Balance

Get wallet balance by currency.

GET /wallet_balance/:currency

Headers

Param Required Description
authorization
string 		Yes Set value to Bearer SECRET_KEY

Query Param

Param Required Description
currency
string 		Yes search transfers by specific currency (e.g NGN) 
{
    "success": true,
    "message": "Wallet Balance Fetched Successfully",
    "data": {
        "currency": "NGN",
        "balance": "105"
    }
}

curl https://budpay.ng/api/v1/wallet_balance/:currency
-H "Authorization: Bearer YOUR_SECRET_KEY"
-X GET