NUBAN Payouts
The NUBAN Payouts API allows you to initiate and manage payouts (transfers) to Nigerian bank accounts and payout options.
This endpoint initiates a Nigerian bank transfer with a specified payment channel.
When creating a payout, we recommend that you first create a beneficiary and add a payment method to the beneficiary to enable you to make payout. However, you can make a payout without creating a beneficiary by providing the account_number and bank_code and we will validate the account details and create the payout within the same request.
Authorizations
Body
beneficiary_payout_option_uuidstringOptional
The UUID of the beneficiary's payment method
bank_codestringOptional
You can provide the bank code to instantly create a payout without creating a beneficiary.
account_numberstringOptional
You can provide the account number to instantly create a payout without creating a beneficiary.
amountstringRequired
The amount you want to payout
currencystring | nullOptional
The currency of the payout. Defaults to NGN
referencestring | nullOptional
Your unique reference for this payout
descriptionstringRequired
A description for the payout
payment_channelstring | nullOptional
The slug of the payment channel that Asyncpay should route this payout through.
meta_dataobject | nullOptional
An arbitrary object to store additional data for the payout
Responses
201Success
application/json
post
POST /v1/payouts/nuban/ HTTP/1.1
Host:
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 184
{
"beneficiary_payout_option_uuid": "f7ad6dc1-3a4f-11f0-ac87-92433b0171f7",
"amount": "100",
"currency": "NGN",
"description": "Dancing all night in the sunlight",
"payment_channel": "paystack"
}201Success
{
"message": "NUBAN payout created and requires OTP verification",
"status": "success",
"data": {
"payout": {
"uuid": "a35b2333-3a51-11f0-ac87-92433b0171f7",
"ref": "AsPR-5418759585789c63978482",
"env_mode": "live",
"initiated_from": "api",
"initiated_by": null,
"type": "nuban",
"is_one_time_beneficiary": 0,
"amount": "100",
"amount_to_usd": "0.0631",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Dancing all night in the sunlight",
"status": "otp",
"status_is_conclusive": 0,
"status_summary": "Transfer requires OTP",
"meta_data": null,
"callback_url": null,
"created_at": "2025-05-26T16:51:15.000000Z",
"updated_at": "2025-05-26T16:51:17.000000Z",
"transfer_ref": "AsNT-0961693a63599",
"reference": "AsPR-5418759585789c63978482",
"beneficiary_payout_option": {
"uuid": "f7ad6dc1-3a4f-11f0-ac87-92433b0171f7",
"third_party_ids": {
"paystack": "RCP_42pfuquvktl2ttm"
},
"is_one_time_beneficiary": 0,
"env_mode": "live",
"payment_method_code": "PMC-2546648294955",
"created_at": "2025-05-26T16:39:18.000000Z",
"updated_at": "2025-05-26T16:39:18.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "f7477e46-3a4f-11f0-ac87-92433b0171f7",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true
},
"bank_code": "232",
"account_number": "0090269960",
"account_name": "ERIC OBELEDATE APRIOKU",
"created_at": "2025-05-26T16:39:17.000000Z",
"updated_at": "2025-05-26T16:39:17.000000Z",
"bank": {
"uuid": "c38c8157-0482-11ef-9b04-5e7b61135574",
"bank_name": "Sterling Bank",
"bank_slug": "sterling-bank",
"bank_code": "232",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"payment_channel_bank_codes": null,
"created_at": "2024-04-27T10:41:54.000000Z",
"updated_at": "2024-04-27T10:41:54.000000Z"
}
}
},
"beneficiary": {
"uuid": "f6d745eb-3a4f-11f0-ac87-92433b0171f7",
"is_one_time_beneficiary": 0,
"beneficiary_id": "AsB-4a98442391633",
"env_mode": "live",
"name": "Nico Robin",
"email": "[email protected]",
"created_at": "2025-05-26T16:39:16.000000Z",
"updated_at": "2025-05-26T16:39:16.000000Z",
"payouts_count": 1,
"payout_options_count": 1,
"payout_options": [
{
"uuid": "f7ad6dc1-3a4f-11f0-ac87-92433b0171f7",
"third_party_ids": {
"paystack": "RCP_42pfuquvktl2ttm"
},
"is_one_time_beneficiary": 0,
"env_mode": "live",
"payment_method_code": "PMC-2546648294955",
"created_at": "2025-05-26T16:39:18.000000Z",
"updated_at": "2025-05-26T16:39:18.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "f7477e46-3a4f-11f0-ac87-92433b0171f7",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true
},
"bank_code": "232",
"account_number": "0090269960",
"account_name": "ERIC OBELEDATE APRIOKU",
"created_at": "2025-05-26T16:39:17.000000Z",
"updated_at": "2025-05-26T16:39:17.000000Z",
"bank": {
"uuid": "c38c8157-0482-11ef-9b04-5e7b61135574",
"bank_name": "Sterling Bank",
"bank_slug": "sterling-bank",
"bank_code": "232",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"payment_channel_bank_codes": null,
"created_at": "2024-04-27T10:41:54.000000Z",
"updated_at": "2024-04-27T10:41:54.000000Z"
}
}
}
]
},
"beneficiary_payment_method": null
},
"otp_url": "https://api.asyncpay.io/v1/payouts/nuban/finalize"
}
}This endpoint retries a payout.
You can only retry a payout when it is in a conclusive failed state. This is because payouts are asynchronous and we need to ensure the payouts are no longer being processed before a new payout is attempted to prevent duplicate transactions or race conditions.
Authorizations
Body
payout_uuidstringRequired
payment_channelstringRequired
Responses
201Success
application/json
post
POST /v1/payouts/nuban/retry HTTP/1.1
Host:
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 86
{
"payout_uuid": "4e68c3af-f783-11ee-8ab1-0242ac180006",
"payment_channel": "flutterwave"
}201Success
{
"message": "NUBAN payout created and relayed successfully",
"status": "success",
"data": {
"uuid": "4e68c3af-f783-11ee-8ab1-0242ac180006",
"ref": "AsPR-70421a0617521PMCKDU_1",
"user_ref": null,
"env_mode": "test",
"type": "nuban",
"beneficiary_id": 37,
"payout_sender_type": null,
"amount": "100",
"currency": "NGN",
"description": "Dancing all night in the sunlight",
"status": "awaiting_verification",
"status_is_conclusive": 0,
"status_summary": "Transfer is being processed",
"meta_data": null,
"callback_url": null,
"created_at": "2024-04-10T21:43:02.000000Z",
"updated_at": "2024-04-10T21:44:38.000000Z",
"transfer_ref": "AsNT-c8630301c101b",
"payout_sender": null,
"beneficiary": {
"uuid": "4e4dac10-f782-11ee-8ab1-0242ac180006",
"env_mode": "test",
"name": "Eric McWinNEr",
"email": "[email protected]",
"created_at": "2024-04-10T21:35:52.000000Z",
"updated_at": "2024-04-10T21:35:52.000000Z"
},
"beneficiary_payment_method": {
"uuid": "4f130b27-f782-11ee-8ab1-0242ac180006",
"third_party_ids": "{\"flutterwave\": null}",
"env_mode": "test",
"bank_code": "044",
"account_number": "0690000032",
"account_name": "Pastor Bright",
"created_at": "2024-04-10T21:35:53.000000Z",
"updated_at": "2024-04-10T21:35:56.000000Z",
"beneficiary_payment_method_code": "",
"bank": {
"uuid": "716820b2-dee2-11ee-b282-2eb51fdfc401",
"bank_name": "Access Bank",
"bank_slug": "access-bank",
"bank_code": "044",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2024-03-10T13:31:04.000000Z",
"updated_at": "2024-03-10T13:31:05.000000Z"
}
}
}
}This endpoint lists the NUBAN payouts in your business
Authorizations
Query parameters
pagestringOptional
The page to fetch from
per_pagestringOptional
The number of items to show on each page
Responses
200Success
application/json
get
GET /v1/payouts/nuban/ HTTP/1.1
Host:
Authentication: YOUR_API_KEY
Accept: */*
200Success
{
"message": "NUBAN payouts fetched successfully",
"status": "success",
"data": [
{
"uuid": "d8b32c58-557e-11f0-8068-0242ac120006",
"ref": "AsPR-131521667f23364354660",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 64,
"bulk_payout_item_id": 193,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:52:53.000000Z",
"updated_at": "2025-06-30T06:53:54.000000Z",
"transfer_ref": "AsNT-1c63635418964",
"reference": "AsPR-131521667f23364354660",
"beneficiary": {
"uuid": "3a68cff9-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-773b9e7675b56",
"env_mode": "live",
"name": "2003841673-NB-00093",
"email": null,
"created_at": "2025-06-22T02:54:34.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"payouts_count": 84,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "3b1808e0-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_cw1o8x6usnkd4r2"
},
"env_mode": "live",
"payment_method_code": "PMC-a199697476350",
"created_at": "2025-06-22T02:54:35.000000Z",
"updated_at": "2025-06-24T20:57:19.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "bd41245e-fcb2-11ef-a015-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"bank_code": "NB-00093",
"account_number": "2003841673",
"account_name": "Eric Obeleoate Aprioku",
"created_at": "2025-03-09T06:50:08.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"bank": {
"uuid": "3d8d494f-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Kuda Bank",
"bank_slug": "kuda-bank",
"bank_code": "NB-00093",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:37.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "d4dfbd0e-557e-11f0-8068-0242ac120006",
"ref": "AsPR-130469254134ff6651356",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 64,
"bulk_payout_item_id": 192,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:52:47.000000Z",
"updated_at": "2025-06-30T06:53:52.000000Z",
"transfer_ref": "AsNT-2f79666759682",
"reference": "AsPR-130469254134ff6651356",
"beneficiary": {
"uuid": "3883d458-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-85052f7f277f2",
"env_mode": "live",
"name": "2117394416-NB-00165",
"email": null,
"created_at": "2025-06-22T02:54:31.000000Z",
"updated_at": "2025-06-22T02:54:31.000000Z",
"payouts_count": 63,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "38f8d6d5-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_jt40sdh0yicd88b"
},
"env_mode": "live",
"payment_method_code": "PMC-6778705529461",
"created_at": "2025-06-22T02:54:32.000000Z",
"updated_at": "2025-06-22T02:54:32.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "6322dc93-3909-11f0-992c-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true
},
"bank_code": "NB-00165",
"account_number": "2117394416",
"account_name": "ERIC OBELEDATE APRIOKU",
"created_at": "2025-05-25T01:41:32.000000Z",
"updated_at": "2025-06-04T04:37:33.000000Z",
"bank": {
"uuid": "3da26ac6-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Zenith Bank",
"bank_slug": "zenith-bank",
"bank_code": "NB-00165",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:38.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "cbb1a41e-557e-11f0-8068-0242ac120006",
"ref": "AsPR-131006063736648284433",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 61,
"bulk_payout_item_id": 191,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:52:32.000000Z",
"updated_at": "2025-06-30T06:53:48.000000Z",
"transfer_ref": "AsNT-4535824936292",
"reference": "AsPR-131006063736648284433",
"beneficiary": {
"uuid": "3a68cff9-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-773b9e7675b56",
"env_mode": "live",
"name": "2003841673-NB-00093",
"email": null,
"created_at": "2025-06-22T02:54:34.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"payouts_count": 84,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "3b1808e0-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_cw1o8x6usnkd4r2"
},
"env_mode": "live",
"payment_method_code": "PMC-a199697476350",
"created_at": "2025-06-22T02:54:35.000000Z",
"updated_at": "2025-06-24T20:57:19.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "bd41245e-fcb2-11ef-a015-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"bank_code": "NB-00093",
"account_number": "2003841673",
"account_name": "Eric Obeleoate Aprioku",
"created_at": "2025-03-09T06:50:08.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"bank": {
"uuid": "3d8d494f-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Kuda Bank",
"bank_slug": "kuda-bank",
"bank_code": "NB-00093",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:37.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "b8e842e0-557e-11f0-8068-0242ac120006",
"ref": "AsPR-130776316320340806034",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 61,
"bulk_payout_item_id": 190,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:52:00.000000Z",
"updated_at": "2025-06-30T06:53:46.000000Z",
"transfer_ref": "AsNT-4515316031263",
"reference": "AsPR-130776316320340806034",
"beneficiary": {
"uuid": "3883d458-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-85052f7f277f2",
"env_mode": "live",
"name": "2117394416-NB-00165",
"email": null,
"created_at": "2025-06-22T02:54:31.000000Z",
"updated_at": "2025-06-22T02:54:31.000000Z",
"payouts_count": 63,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "38f8d6d5-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_jt40sdh0yicd88b"
},
"env_mode": "live",
"payment_method_code": "PMC-6778705529461",
"created_at": "2025-06-22T02:54:32.000000Z",
"updated_at": "2025-06-22T02:54:32.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "6322dc93-3909-11f0-992c-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true
},
"bank_code": "NB-00165",
"account_number": "2117394416",
"account_name": "ERIC OBELEDATE APRIOKU",
"created_at": "2025-05-25T01:41:32.000000Z",
"updated_at": "2025-06-04T04:37:33.000000Z",
"bank": {
"uuid": "3da26ac6-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Zenith Bank",
"bank_slug": "zenith-bank",
"bank_code": "NB-00165",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:38.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "ae10c17f-557e-11f0-8068-0242ac120006",
"ref": "AsPR-1314697473314736488a1",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 60,
"bulk_payout_item_id": 189,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:51:42.000000Z",
"updated_at": "2025-06-30T06:53:42.000000Z",
"transfer_ref": "AsNT-1f76320366360",
"reference": "AsPR-1314697473314736488a1",
"beneficiary": {
"uuid": "3a68cff9-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-773b9e7675b56",
"env_mode": "live",
"name": "2003841673-NB-00093",
"email": null,
"created_at": "2025-06-22T02:54:34.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"payouts_count": 84,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "3b1808e0-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_cw1o8x6usnkd4r2"
},
"env_mode": "live",
"payment_method_code": "PMC-a199697476350",
"created_at": "2025-06-22T02:54:35.000000Z",
"updated_at": "2025-06-24T20:57:19.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "bd41245e-fcb2-11ef-a015-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"bank_code": "NB-00093",
"account_number": "2003841673",
"account_name": "Eric Obeleoate Aprioku",
"created_at": "2025-03-09T06:50:08.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"bank": {
"uuid": "3d8d494f-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Kuda Bank",
"bank_slug": "kuda-bank",
"bank_code": "NB-00093",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:37.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "a2d3e698-557e-11f0-8068-0242ac120006",
"ref": "AsPR-13033b3206e86333e6653",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 60,
"bulk_payout_item_id": 188,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:51:23.000000Z",
"updated_at": "2025-06-30T06:53:39.000000Z",
"transfer_ref": "AsNT-776b081703406",
"reference": "AsPR-13033b3206e86333e6653",
"beneficiary": {
"uuid": "3883d458-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-85052f7f277f2",
"env_mode": "live",
"name": "2117394416-NB-00165",
"email": null,
"created_at": "2025-06-22T02:54:31.000000Z",
"updated_at": "2025-06-22T02:54:31.000000Z",
"payouts_count": 63,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "38f8d6d5-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_jt40sdh0yicd88b"
},
"env_mode": "live",
"payment_method_code": "PMC-6778705529461",
"created_at": "2025-06-22T02:54:32.000000Z",
"updated_at": "2025-06-22T02:54:32.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "6322dc93-3909-11f0-992c-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true
},
"bank_code": "NB-00165",
"account_number": "2117394416",
"account_name": "ERIC OBELEDATE APRIOKU",
"created_at": "2025-05-25T01:41:32.000000Z",
"updated_at": "2025-06-04T04:37:33.000000Z",
"bank": {
"uuid": "3da26ac6-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Zenith Bank",
"bank_slug": "zenith-bank",
"bank_code": "NB-00165",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:38.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "962995c2-557e-11f0-8068-0242ac120006",
"ref": "AsPR-1310616d1676666232336",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 59,
"bulk_payout_item_id": 187,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:51:02.000000Z",
"updated_at": "2025-06-30T06:53:34.000000Z",
"transfer_ref": "AsNT-446896e329422",
"reference": "AsPR-1310616d1676666232336",
"beneficiary": {
"uuid": "3a68cff9-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-773b9e7675b56",
"env_mode": "live",
"name": "2003841673-NB-00093",
"email": null,
"created_at": "2025-06-22T02:54:34.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"payouts_count": 84,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "3b1808e0-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_cw1o8x6usnkd4r2"
},
"env_mode": "live",
"payment_method_code": "PMC-a199697476350",
"created_at": "2025-06-22T02:54:35.000000Z",
"updated_at": "2025-06-24T20:57:19.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "bd41245e-fcb2-11ef-a015-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"bank_code": "NB-00093",
"account_number": "2003841673",
"account_name": "Eric Obeleoate Aprioku",
"created_at": "2025-03-09T06:50:08.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"bank": {
"uuid": "3d8d494f-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Kuda Bank",
"bank_slug": "kuda-bank",
"bank_code": "NB-00093",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:37.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "91d338c6-557e-11f0-8068-0242ac120006",
"ref": "AsPR-13046855294c34e449c09",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 59,
"bulk_payout_item_id": 186,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:50:54.000000Z",
"updated_at": "2025-06-30T06:53:30.000000Z",
"transfer_ref": "AsNT-78a8e2996c8ea",
"reference": "AsPR-13046855294c34e449c09",
"beneficiary": {
"uuid": "3883d458-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-85052f7f277f2",
"env_mode": "live",
"name": "2117394416-NB-00165",
"email": null,
"created_at": "2025-06-22T02:54:31.000000Z",
"updated_at": "2025-06-22T02:54:31.000000Z",
"payouts_count": 63,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "38f8d6d5-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_jt40sdh0yicd88b"
},
"env_mode": "live",
"payment_method_code": "PMC-6778705529461",
"created_at": "2025-06-22T02:54:32.000000Z",
"updated_at": "2025-06-22T02:54:32.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "6322dc93-3909-11f0-992c-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true
},
"bank_code": "NB-00165",
"account_number": "2117394416",
"account_name": "ERIC OBELEDATE APRIOKU",
"created_at": "2025-05-25T01:41:32.000000Z",
"updated_at": "2025-06-04T04:37:33.000000Z",
"bank": {
"uuid": "3da26ac6-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Zenith Bank",
"bank_slug": "zenith-bank",
"bank_code": "NB-00165",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:38.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "0b79a77a-557e-11f0-8068-0242ac120006",
"ref": "AsPR-131142778e3ed724f49d2",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 58,
"bulk_payout_item_id": 185,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:47:09.000000Z",
"updated_at": "2025-06-30T06:48:42.000000Z",
"transfer_ref": "AsNT-6d27958e82082",
"reference": "AsPR-131142778e3ed724f49d2",
"beneficiary": {
"uuid": "3a68cff9-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-773b9e7675b56",
"env_mode": "live",
"name": "2003841673-NB-00093",
"email": null,
"created_at": "2025-06-22T02:54:34.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"payouts_count": 84,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "3b1808e0-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_cw1o8x6usnkd4r2"
},
"env_mode": "live",
"payment_method_code": "PMC-a199697476350",
"created_at": "2025-06-22T02:54:35.000000Z",
"updated_at": "2025-06-24T20:57:19.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "bd41245e-fcb2-11ef-a015-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"bank_code": "NB-00093",
"account_number": "2003841673",
"account_name": "Eric Obeleoate Aprioku",
"created_at": "2025-03-09T06:50:08.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"bank": {
"uuid": "3d8d494f-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Kuda Bank",
"bank_slug": "kuda-bank",
"bank_code": "NB-00093",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:37.000000Z"
}
}
},
"initiated_by_user": null
},
{
"uuid": "0668a951-557e-11f0-8068-0242ac120006",
"ref": "AsPR-13008e5063325e3f83603",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 58,
"bulk_payout_item_id": 184,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:47:01.000000Z",
"updated_at": "2025-06-30T06:48:40.000000Z",
"transfer_ref": "AsNT-6823b2244646b",
"reference": "AsPR-13008e5063325e3f83603",
"beneficiary": {
"uuid": "3883d458-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-85052f7f277f2",
"env_mode": "live",
"name": "2117394416-NB-00165",
"email": null,
"created_at": "2025-06-22T02:54:31.000000Z",
"updated_at": "2025-06-22T02:54:31.000000Z",
"payouts_count": 63,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "38f8d6d5-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_jt40sdh0yicd88b"
},
"env_mode": "live",
"payment_method_code": "PMC-6778705529461",
"created_at": "2025-06-22T02:54:32.000000Z",
"updated_at": "2025-06-22T02:54:32.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "6322dc93-3909-11f0-992c-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true
},
"bank_code": "NB-00165",
"account_number": "2117394416",
"account_name": "ERIC OBELEDATE APRIOKU",
"created_at": "2025-05-25T01:41:32.000000Z",
"updated_at": "2025-06-04T04:37:33.000000Z",
"bank": {
"uuid": "3da26ac6-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Zenith Bank",
"bank_slug": "zenith-bank",
"bank_code": "NB-00165",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:38.000000Z"
}
}
},
"initiated_by_user": null
}
]
}This endpoint fetches a single NUBAN payout with its UUID.
Authorizations
Path parameters
PayoutUUIDstringRequired
The UUID of the NUBAN payout you want to fetch
Responses
200Success
application/json
get
GET /v1/payouts/nuban/fetch/{PayoutUUID} HTTP/1.1
Host:
Authentication: YOUR_API_KEY
Accept: */*
200Success
{
"message": "NUBAN Payout fetched successfully",
"status": "success",
"data": {
"uuid": "d8b32c58-557e-11f0-8068-0242ac120006",
"ref": "AsPR-131521667f23364354660",
"env_mode": "live",
"initiated_from": null,
"type": "nuban",
"is_one_time_beneficiary": 1,
"bulk_payout_id": 64,
"bulk_payout_item_id": 193,
"amount": "28",
"amount_to_usd": "0.0182",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Testing the payouts",
"status": "successful",
"status_is_conclusive": 1,
"status_summary": "Transfer was successful",
"meta_data": null,
"callback_url": null,
"created_at": "2025-06-30T06:52:53.000000Z",
"updated_at": "2025-06-30T06:53:54.000000Z",
"transfer_ref": "AsNT-1c63635418964",
"reference": "AsPR-131521667f23364354660",
"beneficiary": {
"uuid": "3a68cff9-4f14-11f0-a0d2-0242ac120006",
"beneficiary_id": "AsB-773b9e7675b56",
"env_mode": "live",
"name": "2003841673-NB-00093",
"email": null,
"created_at": "2025-06-22T02:54:34.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"payouts_count": 84,
"payout_options_count": 1
},
"beneficiary_payout_option": {
"uuid": "3b1808e0-4f14-11f0-a0d2-0242ac120006",
"third_party_ids": {
"paystack": "RCP_cw1o8x6usnkd4r2"
},
"env_mode": "live",
"payment_method_code": "PMC-a199697476350",
"created_at": "2025-06-22T02:54:35.000000Z",
"updated_at": "2025-06-24T20:57:19.000000Z",
"destination_type": "nuban",
"destination": {
"uuid": "bd41245e-fcb2-11ef-a015-0242ac120006",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"bank_code": "NB-00093",
"account_number": "2003841673",
"account_name": "Eric Obeleoate Aprioku",
"created_at": "2025-03-09T06:50:08.000000Z",
"updated_at": "2025-06-22T02:54:34.000000Z",
"bank": {
"uuid": "3d8d494f-caeb-11ef-a3d3-0242ac130006",
"bank_name": "Kuda Bank",
"bank_slug": "kuda-bank",
"bank_code": "NB-00093",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"created_at": "2025-01-04T22:28:37.000000Z",
"updated_at": "2025-05-27T17:24:37.000000Z"
}
}
},
"initiated_by_user": null,
"timeline": [
{
"uuid": "db605fec-557e-11f0-8068-0242ac120006",
"summary": "Payout initiated on Paystack",
"status": "successful",
"created_at": "2025-06-30T06:52:58.000000Z",
"updated_at": "2025-06-30T06:52:58.000000Z"
},
{
"uuid": "db60c8fd-557e-11f0-8068-0242ac120006",
"summary": "Transfer is being processed on Paystack",
"status": "neutral",
"created_at": "2025-06-30T06:52:58.000000Z",
"updated_at": "2025-06-30T06:52:58.000000Z"
},
{
"uuid": "fcff03d5-557e-11f0-8068-0242ac120006",
"summary": "Payout successful on Paystack",
"status": "successful",
"created_at": "2025-06-30T06:53:54.000000Z",
"updated_at": "2025-06-30T06:53:54.000000Z"
}
]
}
}This endpoint is used to finalize the payout when making requests that requires a verification like an OTP or other multi-factor authentication to complete the payout.
This endpoint requires the payout UUID and the value required to finalize the payout transaction.
Authorizations
Body
otpstringRequired
A one-time password required to complete this payout
payout_uuidstringRequired
The UUID of the payout
Responses
201Success
application/json
post
POST /v1/payouts/nuban/finalize HTTP/1.1
Host:
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 69
{
"otp": "823133",
"payout_uuid": "213fd663-e94f-11ee-9e57-0242ac120006"
}201Success
{
"message": "NUBAN payout finalized successfully",
"status": "success",
"data": {
"uuid": "e4ba172d-3940-11f0-ac87-92433b0171f7",
"ref": "AsPR-531794923d48c269291528",
"env_mode": "live",
"type": "nuban",
"is_one_time_beneficiary": 1,
"amount": "100",
"amount_to_usd": "0.0629",
"payment_channel_slug": "paystack",
"currency": "NGN",
"description": "Dancing all night in the sunlight",
"status": "awaiting_verification",
"status_is_conclusive": 0,
"status_summary": "Transfer is being processed",
"meta_data": null,
"callback_url": null,
"created_at": "2025-05-25T08:18:52.000000Z",
"updated_at": "2025-05-25T08:21:25.000000Z",
"transfer_ref": "AsNT-4456804d04382",
"reference": "AsPR-531794923d48c269291528",
"payout_sender": null,
"beneficiary": {
"uuid": "84b7764d-393f-11f0-ac87-92433b0171f7",
"is_one_time_beneficiary": 1,
"beneficiary_id": "AsB-0168302e21313",
"env_mode": "live",
"name": "2117394416-057",
"email": null,
"created_at": "2025-05-25T08:09:02.000000Z",
"updated_at": "2025-05-25T08:09:02.000000Z",
"payouts_count": 2,
"payment_methods_count": 1
},
"beneficiary_payment_method": {
"uuid": "85295098-393f-11f0-ac87-92433b0171f7",
"third_party_ids": {
"paystack": "RCP_jt40sdh0yicd88b"
},
"is_one_time_beneficiary": 1,
"env_mode": "live",
"payment_method_code": "PMC-7161a42c00d44",
"created_at": "2025-05-25T08:09:02.000000Z",
"updated_at": "2025-05-25T08:09:02.000000Z",
"payment_method_type": "nuban",
"payment_method": {
"uuid": "54726ad8-3875-11f0-ac87-92433b0171f7",
"env_mode": "live",
"payment_channel_availability": {
"paystack": true
},
"bank_code": "057",
"account_number": "2117394416",
"account_name": "ERIC OBELEDATE APRIOKU",
"created_at": "2025-05-24T08:01:42.000000Z",
"updated_at": "2025-05-24T08:01:42.000000Z",
"bank": {
"uuid": "c39abacc-0482-11ef-9b04-5e7b61135574",
"bank_name": "Zenith Bank",
"bank_slug": "zenith-bank",
"bank_code": "057",
"payment_channel_availability": {
"paystack": true,
"flutterwave": true
},
"payment_channel_bank_codes": null,
"created_at": "2024-04-27T10:41:54.000000Z",
"updated_at": "2024-04-27T10:41:54.000000Z"
}
}
}
}
}This endpoint is used to tell a specific payment channel that we want to require an OTP when we process payouts. It is applicable right now for paystack.
Authorizations
Body
payment_channelstringRequired
The slug of the payment channel we want to enable payout OTP for
Responses
200Success
application/json
Responseobject
post
POST /v1/payouts/enable-otp HTTP/1.1
Host:
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"payment_channel": "text"
}200Success
{}This endpoint is used to tell a specific payment channel that we want to process payouts without requiring an OTP. It is applicable right now for paystack.
When performing payouts, some payment channels require you to do some form of multi-factor authentication with an OTP, and would need you to do a second call to finalize the payout. When you disable this process with this endpoint, you no longer need to do that.
Authorizations
Body
payment_channelstringRequired
The slug of the payment channel we want to disable payout OTP for
Responses
200Success
application/json
Responseobject
post
POST /v1/payouts/disable-otp HTTP/1.1
Host:
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26
{
"payment_channel": "text"
}200Success
{}This endpoint is useful as a final step for disabling the OTP of a specific payment channel. For payment channels that require an OTP to complete the disabling process to disable payout OTPs, we use this endpoint to complete the process.
Authorizations
Body
payment_channelstringRequired
The slug of the payment channel we want to finalize the disable payout OTP request for.
otpstringRequired
The OTP to finalize this request.
Responses
200Success
application/json
Responseobject
post
POST /v1/payouts/finalize-disable-otp HTTP/1.1
Host:
Authentication: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39
{
"payment_channel": "text",
"otp": "text"
}200Success
{}Last updated