NUBAN Bulk Payouts

The NUBAN Bulk Payouts API allows you to initiate multiple NUBAN payouts across different payment channels in one request. It also allows you manage bulk payouts.

Create Bulk Payout

post

This endpoint initiates a bulk payout request with a JSON array.

It supports payouts with either the account number and bank code or the beneficiary payout option.

When the request is submitted, the payouts are then queued after which they will be individually initated and processed. You can query the endpoint to get a bulk payout by its UUID to see the status of the bulk payout and its individual payouts. You can also listen for the webhook to know when a bulk payout has been completely processed.

Authorizations
AuthenticationstringRequired
Body
payment_channelstringRequired

The payment channel to use for all the requests. Providing a payment_channel on a specific payout item overrides this value.

Responses
chevron-right
201Success
application/json
post
/v1/payouts/nuban/bulk
201Success

Create Bulk Payout from CSV

post

This endpoint initiates a bulk payout request with a CSV file.

It supports payouts with either the account number and bank code or the beneficiary payout option.

It expects a CSV file with the following format:

account_number, bank_code,beneficiary_payout_option_uuid, amount, currency, description, payment_channel

The required fields for each line are: payment_channel, description and amount. account_number and bank_code is required if beneficiary_payout_option_uuid is not present in any line.

When the CSV is uploaded and validated, the payouts are then queued after which they will be individually initated and processed. You can query the endpoint to get a bulk payout by its UUID to see the status of the bulk payout and its individual payouts. You can also listen for the webhook to know when a bulk payout has been completely processed.

Authorizations
AuthenticationstringRequired
Body
filestring · binaryOptionalExample: file:///Users/ericmcwinner/Documents/Work/Projects/Work/Laravel/async-pay/storage/app/public/sample_nuban_bulk_payout.csv
Responses
chevron-right
201Success
application/json
post
/v1/payouts/nuban/bulk/csv
201Success

List Bulk Payouts

get

Lists all the bulk payouts in a business

Authorizations
AuthenticationstringRequired
Responses
get
/v1/payouts/nuban/bulk
200Success

Fetch Bulk Payout

get

This endpoint fetches the complete details of a bulk payout

Authorizations
AuthenticationstringRequired
Path parameters
BulkPayoutUUIDstringRequired

The UUID of the bulk payout we want to fetch

Responses
get
/v1/payouts/nuban/bulk/{BulkPayoutUUID}
200Success

Last updated