Bank
To payout funds to a customer's bank, we need to know the recipient's bank by id. We refer to this as the bank code. Use the API below to initiate a payout request.
Bank Payout API
POST
https://sandbox.dusupay.com/v1/payouts
Headers
Name | Type | Description |
---|---|---|
Content-Type* | String | application/json |
Request Body
Name | Type | Description |
---|---|---|
api_key* | String | Obtained from merchant account setting |
currency* | String | You can use your home currency when making requests. e.g USD You will receive your funds at the market rate into your merchant sub-account. |
amount* | Int/Double | 2 decimal places allowed for double. |
method* | String | BANK |
provider_id* | String | e.g bank_ng. Get the list of providers from Payment OptionsAPI |
account_number* | String | For European, UK, Germany bank payouts, set |
merchant_reference* | String | The UNIQUE reference for this transaction generated by your system. A unique string value should be sent for every attempt.
|
narration* | String | Use this to add a brief description or comment on the transaction.
|
account_name* | String | Customer's name |
account_email | String | Used to email customer. Helps to easily lookup customer transactions. |
extra_params* | String | takes an object with at least bank_code as a parameter.See how its used below |
NB: We currently support bank payouts only in Nigeria (NG) and South Africa(ZA).
Extra Parameters
Different countries require different extra information to send money to customer’s accounts correctly.
Below are some of the fields per country that are required to be included in the
extra_params
the field when making a payout request.
Method | Extra fields | Description |
---|---|---|
Nigeria - BANK | The Bank code of Nigeria Bank | |
South Africa - BANK | The bank code of South African Bank. |
Last updated