API ReferenceGet API keysGet Integration SupportBlog

African Payouts

Suggest Edits

Payments to bank accounts in African countries are covered in this section.

📘

Understanding the sections below is required to fully comprehend how the payout API works.


Payout Endpoint

This endpoint is used to process transfers in all currencies we support and regions we cover. To test a payout please see the API Reference

{{host}}/v2/payouts/

NGN Payouts

The parameters that can be used to process payment to a Nigerian Bank Account (NUBAN) are explained below

FieldMandatoryTypeDescription
businessYesstringThe ID of the business making the payout.
sourceCurrencyYesstringThe currency which is used to fund the payout
destinationCurrencyYesstringThe currency in which the recipient will be receiving funds
amountYesstringThe value that is to be transferred from the source currency wallet.
descriptionYesstringThe description of the payout
paymentDestinationYesstringThis is the type of account you want to send your payments to, see payment destinations for more details .
customerReferenceNostringThis is the unique reference generated for the transaction on your platform.
quoteReferenceNostringThis is the reference generated when the source currency is compared against the destination currency. This is required when the source currency is not the same as the destination currency. You can generate a quote using the Generate quote endpoint.
beneficiaryYesobjectThe recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different. The following tables detail the various beneficiaries.
beneficiary.firstNameNostringThe first name of the beneficiary . This is only required when you want to make payments to an individual beneficiary
beneficiary.lastNameNostringThis field is optional and only applies to payments that can be made to individual beneficiaries.
beneficiary.accountHolderNameYesstringThis field is required by both individual and corporate beneficiaries.
beneficiary.accountNumberYesstringThis is the bank account number of the beneficiary or phone number if the account is a mobile money wallet.
beneficiary.typeYesstringThe type of beneficiary, see beneficiary types for more details
beneficiary.countryNostringThe country in which the beneficiary resides.
beneficiary.emailNostringThe beneficiary's email
beneficiary.bankCodeYesstringThe beneficiary bank code. To get the bank code please see the bank codes for more details. This is required for NGN payouts

The payload should look like this :

{
    "business": "{{The business ID}}",
    "sourceCurrency": "NGN",
    "destinationCurrency": "NGN",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}

GHS, KES Payouts

The parameters that can be used to process payments to Ghana and Kenya bank accounts are explained below

FieldMandatoryTypeDescription
businessYesstringThe ID of the business making the payout.
sourceCurrencyYesstringThe currency which is used to fund the payout
destinationCurrencyYesstringThe currency in which the recipient will be receiving funds
amountYesstringThe value that is to be transferred from the source currency wallet.
descriptionYesstringThe description of the payout
paymentDestinationYesstringThis is the type of account you want to send your payments to, see payment destinations for more details
customerReferenceNostringThis is the unique reference generated for the transaction on your platform.
quoteReferenceNostringThis is the reference generated when the source currency is compared against the destination currency. This is required when the source currency is not the same as the destination currency. You can generate a quote using the Generate quote endpoint.
beneficiaryYesobjectThe recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different. The following tables detail the various beneficiaries.
beneficiary.firstNameNostringThe first name of the beneficiary . This is only required when you want to make payments to an individual beneficiary
beneficiary.lastNameNostringThis field is optional and only applies to payments that can be made to individual beneficiaries.
beneficiary.accountHolderNameYesstringThis field is required by both individual and corporate beneficiaries.
beneficiary.accountNumberYesstringThis is the bank account number of the beneficiary or phone number if the account is a mobile money wallet.
beneficiary.typeYesstringThe type of beneficiary, see beneficiary types for more details
beneficiary.countryNostringThe country in which the beneficiary resides.
beneficiary.emailNostringThe beneficiary's email
beneficiary.bankCodeYesstringThe beneficiary bank code. To get the bank code please see the bank codes for more details. This is required for NGN payouts

The payload should look like this :

{
    "business": "{{The business ID}}",
    "sourceCurrency": "NGN",
    "destinationCurrency": "KES",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}

{
    "business": "{{The business ID}}",
    "sourceCurrency": "NGN",
    "destinationCurrency": "GHS",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "quoteReference": "1330bd3c-1e09-4c1c-887f-7f1d72ff905e",
    "beneficiary": {
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "0124775489",
        "type": "individual",
        "email": "[email protected]",
        "bankCode": "058"
    }
}

Updated over 1 year ago