Bank Account Transfers

This section covers the parameters needed to process payments to bank accounts. Bank account transfers follow the same basic format: make a POST request to our Payout API. However, depending on the type of beneficiary and the account's currency, you might need to give some extra information.

Common Details

So first, let's go through the basic information needed for any kind of account. You'll need to provide these details.

Field	Mandatory	Type	Description
business	Yes	String	The ID of the business making the payout.
sourceCurrency	Yes	String	The currency which is used to fund the payout
destinationCurrency	Yes	String	The currency in which the recipient will be receiving funds
amount	Yes	String	The value that is to be transferred from the source currency wallet.
description	Yes	String	A simple description of payment e.g "From Daniella”
paymentDestination	Yes	String	This is the type of account you want to send your payments to, see payment destinations for more details.
customerReference	Yes	String	The transaction's unique identifier on your system. Customer references prevent duplicate transactions. We advise that you add it to your payload
quoteReference	No	String	This is the reference generated when the source currency is compared against the destination currency. This is required for cross-currency payouts. You can generate a quote using the Generate quote endpoint.
sender	No	Object	The details of the customer initiating the payout
sender.name	No	String	The customer's full name. This name would show up in the transfer narration.
sender.email	No	String	The customer's email.

NGN Pay-Outs

In addition to the common details needed to process successful payments, the following fields are also required when sending money to a bank account in Nigeria.

Field	Mandatory	Type	Description
beneficiary	Yes	Object	The recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different.
beneficiary.firstName	Yes	String	The first name of the beneficiary .
beneficiary.lastName	Yes	String	The last name of the beneficiary
beneficiary.accountHolderName	Yes	String	This field is required by all type of beneficiaries.
beneficiary.type	Yes	String	The type of beneficiary, see beneficiary types for more details
beneficiary.country	No	String	The country in which the bank of the beneficiary is located. This field should be according to ISO 3166-1 alpha-2 codes standards e.g NG, GB
beneficiary.email	No	String	The beneficiary's email
beneficiary.bankCode	Yes	String	The beneficiary bank code. To get the bank code please see the list banks endpoint codes for more details.

The payload should look like this :

{
    "amount": 5070,
    "beneficiary": {
        "accountHolderName": "Customer Name",
        "accountNumber": "17874878234",
        "bankCode": "044",
        // "country": "NG",
        "firstName": "Customer",
        "lastName": "Name",
        "type": "individual"
    },
    "business": "{{Your Business ID}}",
    "customerReference": "{{$randomUUID}}",
    "description": "Test",
    "destinationCurrency": "NGN",
    "paymentDestination": "bank_account",
    "sourceCurrency": "NGN",
    "sender":{
        "name":"Customer Name",
        "email":"[email protected]"
    }
}

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

ZMW Pay-Outs

In addition to the common details needed to process successful payments, the following fields are also required when sending money to a bank account in Zambia.

Field	Mandatory	Type	Description
beneficiary	Yes	Object	The recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different.
beneficiary.firstName	Yes	String	The first name of the beneficiary .
beneficiary.lastName	Yes	String	The last name of the beneficiary
beneficiary.accountHolderName	Yes	String	This field is required by all type of beneficiaries.
beneficiary.type	Yes	String	The type of beneficiary, see beneficiary types for more details
beneficiary.country	No	String	The country in which the bank of the beneficiary is located. This field should be according to ISO 3166-1 alpha-2 codes standards e.g NG, GB
beneficiary.email	No	String	The beneficiary's email
beneficiary.bankCode	Yes	String	The beneficiary bank code. To get the bank code please see the list banks endpoint codes for more details.

The payload should look like this :

{
    "business": "{{Your Business ID}}",
    "sourceCurrency": "ZMW",
    "destinationCurrency": "ZMW",
    "amount": "121",
    "paymentDestination": "bank_account",
    "customerReference": "{{$randomUUID}}",
    "beneficiary": {
        "firstName": "Test",
        "lastName": "Technologies",
        "email": "[email protected]",
        "accountHolderName": "Tebogo Njoroge",
        "type": "individual",
        "country": "ZM",
        "accountNumber": "260961111111",
        "bankCode": "002"
    },
    "description": "Test",
    "sender": {
        "name": "Customer Name",
        "email":"[email protected]"
    }
}

GBP Pay-Outs

In addition to the common details needed to process a successful payment, the following fields are also required when sending money to a bank account in the United Kingdom.

Field	Mandatory	Type	Description
beneficiary	Yes	Object	The recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different.
beneficiary.accountHolderName	Yes	String	This field is required by all types of beneficiaries.
beneficiary.accountNumber	Yes	String	This is the bank account number of the beneficiary.
beneficiary.type	Yes	String	The type of beneficiary, see beneficiary types for more details
beneficiary.country	Yes	String	The country in which the bank of the beneficiary is located. This field should be according to ISO 3166-1 alpha-2 codes standards e.g NG, GB
beneficiary.email	Yes	String	The type of beneficiary, see beneficiary types for more details
beneficiary.bankSwiftCode	No	String	The beneficiary's bank swift code according to ISO9362 . e.g UBSWCHZH80A
beneficiary.sortCode	Yes	String	The beneficiary's bank sort code. Sort codes are the domestic bank codes used to route money transfers between financial institutions in the United Kingdom, and in the Republic of Ireland. e.g 000000
paymentScheme	Yes	String	The payment scheme is relevant to the destination currency and region.

The payload should look like this :

{
    "business": "{{The business ID}}",
    "sourceCurrency": "GBP",
    "destinationCurrency": "GBP",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "GBXXCLJU04130780008933",
        "type": "individual",
        "email": "[email protected]",,
        "sortCode" : "000000"
    },
    "paymentScheme": "fps",
    "quoteReference": "d187b2fa-27cd-43e6-b622-66361e409c6d"
}

{
    "business": "{{The business ID}}",
    "sourceCurrency": "GBP",
    "destinationCurrency": "GBP",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "GBXXCLJU04130780008933",
        "type": "individual",
        "email": "[email protected]",,
        "sortCode" : "000000",
        "bankSwiftCode" : "UBSWCHZH80A"
    },
    "paymentScheme": "chaps",
    "quoteReference": "d187b2fa-27cd-43e6-b622-66361e409c6d"
}

EUR Pay-Outs

In addition to the common details needed to process a successful payment, the following fields are also required when sending money to a bank account in the European Union.

Field	Mandatory	Type	Description
beneficiary	Yes	Object	The recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different.
beneficiary.accountHolderName	Yes	String	This field is required by all types of beneficiaries.
beneficiary.accountNumber	Yes	String	This is the IBAN of the beneficiary.
beneficiary.type	Yes	String	The type of beneficiary, see beneficiary types for more details
beneficiary.country	Yes	String	The country in which the bank of the beneficiary is located. This field should be according to ISO 3166-1 alpha-2 codes standards e.g NG, GB
beneficiary.email	Yes	String	The type of beneficiary, see beneficiary types for more details
paymentScheme	Yes	String	The payment scheme relevant to the destination currency and region.

The payload should look like this :

{
    "business": "{{The business ID}}",
    "sourceCurrency": "EUR",
    "destinationCurrency": "EUR",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "GBXXCLJU04130780008933",
        "type": "individual",
        "email": "[email protected]",
    },
    "paymentScheme": "sepa",
    "quoteReference": "d187b2fa-27cd-43e6-b622-66361e409c6d"
}

{
    "business": "{{The business ID}}",
    "sourceCurrency": "EUR",
    "destinationCurrency": "EUR",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "beneficiary": {
        "firstName": "Hassan",
        "lastName": "Sarz",
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0803443433",
        "accountNumber": "GBXXCLJU04130780008933",
        "type": "individual",
        "email": "[email protected]",
    },
    "paymentScheme": "sepa",
    "quoteReference": "d187b2fa-27cd-43e6-b622-66361e409c6d"
}

USD Pay-Outs

In addition to the common details needed to process a successful payment, the following fields are also required when sending money to a bank account in the United States.

Also, we have catered for making bank transfers to Nigerian Banks for USD Domiciliary account payments.
Kindly find attached supported bank list here

Field	Mandatory	Type	Description
files	Yes	String/file/array	A document explaining the reason for the payment. This can be a file upload or an accessible file URL.
paymentScheme	Yes	String	The payment scheme relevant to the destination currency and region.
beneficiary	Yes	Object	The recipient of the funds. Depending on the currency and beneficiary type, the properties of the beneficiaries are different.
beneficiary.firstName	Yes	String	The first name of the beneficiary
beneficiary.lastName	Yes	String	The last name of the beneficiary .
beneficiary.phoneNumber	No	String	The mobile number of the beneficiary
beneficiary.accountHolderName	Yes	String	This is the bank account number of the beneficiary
beneficiary.accountNumber	Yes	String	This is the bank account number of the beneficiary or phone number if the account is a mobile money wallet.
beneficiary.type	Yes	String	The type of beneficiary, see beneficiary types for more details
beneficiary.country	Yes	String	The country in which the bank of the beneficiary is located. This field should be according to ISO 3166-1 alpha-2 codes standards e.g NG, GB
beneficiary.email	No	String	The beneficiary's email
beneficiary.bankSwiftCode	No	String	The bank swift code according to ISO9362 . These two letters indicate the country where the bank is located.e.g UBSWCHZH80A

The payload should look like this :

{
    "business": "{{The business ID}}",
    "sourceCurrency": "USD",
    "destinationCurrency": "USD",
    "amount": "1000",
    "description": "i want to pay my vendor",
    "paymentDestination": "bank_account",
    "beneficiary": {
        "accountHolderName": "Hassan Sarz",
        "country": "NG",
        "phone": "0123456789",
        "accountNumber": "0123456789",
        "type": "corporate",
        "email": "[email protected]",
    },
    "paymentScheme": "swift",
    "files": "https://fastly.picsum.photos/id/304/200/300.jpg?hmac=YXd3iLkNQM9NGjwZ31Tiycz66IymYZreYRfvXIrq6l8",
    "customerName": "Hassan Sars",
}