curl --request POST \
--url https://api.payaza.africa/live/payout-receptor/payout \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'X-TenantID: <api-key>' \
--data '
{
"transaction_type": "nuban",
"service_payload": {
"payout_amount": 100,
"transaction_pin": 419374,
"account_reference": "1010000009",
"currency": "NGN",
"country": "NGA",
"payout_beneficiaries": [
{
"credit_amount": 100,
"account_number": "9207067319",
"account_name": "John Doe",
"bank_code": "000013",
"narration": "Test",
"transaction_reference": "TD93001234",
"sender": {
"sender_name": "Jane Doe",
"sender_id": "",
"sender_phone_number": "01234595",
"sender_address": "123, Ace Street"
}
}
]
}
}
'
{
"response_code": 200,
"response_message": "Request successfully submitted",
"response_content": {
"transaction_status": "09",
"narration": "Payout",
"transaction_time": "2023-10-19T14:37:35.517809",
"amount": 100,
"response_status": "TRANSACTION_INITIATED",
"response_description": "Transaction has been successfully submitted for processing"
},
"resp_code": "09"
}
Transfers
Initiate A Transfer
Send funds from your Payaza account to a bank account or mobile wallet. Supports single and bulk payouts. See the full Transfers guide for a step-by-step walkthrough.
Before you call this endpoint:
- Your server IP address must be whitelisted on the Payaza Dashboard under Settings → Developers → IP Whitelisting (live environment only).
- Your transaction PIN must be set up on the dashboard under Settings → Profile → Security.
- The
account_referenceis retrieved from the View Payaza Account Details endpoint. - Bank codes for each supported country are available here
- Cross-border payouts outside Nigeria are not enabled by default — email support@payaza.africa to activate this on your account.
POST
/
payout-receptor
/
payout
curl --request POST \
--url https://api.payaza.africa/live/payout-receptor/payout \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'X-TenantID: <api-key>' \
--data '
{
"transaction_type": "nuban",
"service_payload": {
"payout_amount": 100,
"transaction_pin": 419374,
"account_reference": "1010000009",
"currency": "NGN",
"country": "NGA",
"payout_beneficiaries": [
{
"credit_amount": 100,
"account_number": "9207067319",
"account_name": "John Doe",
"bank_code": "000013",
"narration": "Test",
"transaction_reference": "TD93001234",
"sender": {
"sender_name": "Jane Doe",
"sender_id": "",
"sender_phone_number": "01234595",
"sender_address": "123, Ace Street"
}
}
]
}
}
'
{
"response_code": 200,
"response_message": "Request successfully submitted",
"response_content": {
"transaction_status": "09",
"narration": "Payout",
"transaction_time": "2023-10-19T14:37:35.517809",
"amount": 100,
"response_status": "TRANSACTION_INITIATED",
"response_description": "Transaction has been successfully submitted for processing"
},
"resp_code": "09"
}
Authorizations
Payaza {{Public API Key in Base 64}}
live or test
Body
application/json
The type of account being transferred to.(Default is NGN). NGN == “nuban”, GHS == “mobile_money” or “ghipps”, UGX == “mobile_money” , TZS == “mobile_money” or “tiss”, KES == “mobile_money” or “kepss”, XOF == “mobile_money” or “wave”, XAF == “mobile_money”, LRD == “mobile_money”, SLE == “mobile_money”, ZMW == “mobile_money”, COD == “mobile_money” ZAR == “RTC”
Example:
"nuban"
It contains the details of the service payload.
Show child attributes
Show child attributes