Payout details

This document lists the required details that needs to be sent for each of our payout corridor

Note Occasionally there might be issues with one of the corridors and we might have to disable them temporarily. Once youre onboarded we’ll let you know if this happens. Also if you’re trying to use a disabled corridor you’re going to receive a validation error stating that the corridor is not active, and you won’t be able to create new transactions there.

Nigeria

NGN::Bank

For Nigerian bank payments please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "bank_code": "058",
  "bank_account": "123456789",
  "bank_account_type": "10"
    // 10 for saving
    // 20 for current accounts
}

The valid bank_code values are:

Access Bank: 044
EcoBank: 050
FCMB Bank: 214
Fidelity Bank: 070
First Bank of Nigeria: 011
Guaranty Trust Bank : 058
Heritage Bank: 030
Jaiz Bank: 301
Keystone: 082
Polaris Bank: 076
Stanbic IBTC Bank: 039
Standard Chartered Bank PLC: 068
Sterling bank: 232
Suntrust Bank: 100
Union Bank: 032
United Bank for Africa: 033
Unity Bank: 215
Wema Bank: 035
Zenith International: 057

Note! Diamond Bank was merged with Access Bank in 2019. For Diamond Bank recipients please use Access Bank as the bank code

NGN::Mobile

For Nigerian mobile payments please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "phone_number": "7087661234"
    // local Nigerian format
}

Warning! The recipient has to be registered and KYC’d with https://www.mypaga.com before they can receive funds. If they are not registered when the payment occurs then Paga can hold the funds until the user registers and approves themselves.

Ghana

GHS::Bank

For Ghanan bank payments please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "bank_code": "030100",
  "bank_account": "123456789"
}

The current banks supported and their bank_codes values are:

Access Bank: 280100
Barclays Bank: 030100
GCB Bank: 040100
Ecobank: 130100
First National Bank: 330100
Heritage Bank: 370100
Prudential Bank: 180100
Stanbic Bank: 190100
Standard Chartered Bank: 020100
United Bank for Africa: 060100
Zenith Bank: 120100
Fidelity Bank: 240100

Please note that there is no standard format across banks for account numbers in this corridor. If you wish to check for correctness you can see the following list:

Access Bank: 13 digits
Barclays Bank: 10 or 13 digits
GCB Bank: 13 digits
Ecobank: 13 or 16 digits
First National Bank: 11 digits
Heritage Bank: 13 digits
Prudential Bank: 13 digits
Stanbic Bank: 13 digits
Standard Chartered Bank: 13 digits
United Bank for Africa: 13 or 14 digits
Zenith Bank: 10 digits
Fidelity Bank: 13 digits

GHS::Mobile

For Ghanan mobile payments please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "phone_number": "302123456"
  "mobile_provider": "tigo" // optional
}

Although the mobile_provider field is optional, if you send us the proper value we can provider a quicker and faster settlement. The valid values are:

airtel
mtn
tigo
vodafone

Uganda

UGX::Mobile

For Ugandan mobile payments please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "phone_number": "256772123456"
    // local or international Ugandan format
}

Note! The provider might check the name against the registered holder of the mobile number and block transactions if they don’t match.

Tanzania

TZS::Mobile

For Tanzanian mobile payments please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "phone_number": "221231234"
    // local Tanzanian format
}

Europe / SEPA

EUR::Bank

For EUR IBAN transfers please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "bank_name": "Deutsche Bank",
  "iban": "DE89370400440532013000",
  "bic": "DEUTDEBBXXX" // Optional
}

Warning! If the recipient account is not an EUR account then the recipient’s bank might charge for converting the received funds from EUR to the local currency.

Note! Transfer is done using the fastest method available on the recipient’s bank.

  • If the recipient’s bank supports the Instant Payment network funds will arrive within 2 hours (but usually within a couple minutes)
  • If the recipient’s bank supports the SEPA system, funds will arrive within 1-2 business days
  • If the recipient’s bank only supports the Swift system, funds will arrive within 2-5 business days

GBP::Bank

For GBP::Bank there are two payout options available:

  1. GBP Payments with account number and sort code
  2. GBP IBAN transfers

For GBP Payments with account number and sort code please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "bank_name": "Lloyds Bank",
  "bank_account": "12345678",
  "sort_code": "123456"
}

For GBP IBAN transfers please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "bank_name": "Lloyds Bank",
  "iban": "GB29LOYD60161331926819",
  "bic": "LOYDGB2L" // Optional
}

Warning! If the recipient account is not an GBP account then the recipient’s bank might charge for converting the received funds from GBP to the local currency.

Note!

  • The customer needs to enter either an IBAN (and an optional BIC), or an account number and sort code.
  • Transfer is done using the fastest method available on the recipient’s bank.
  • If the recipient’s bank is in the UK, and supports the Faster Payment network funds will arrive within 2 hours (but usually within a couple minutes)
  • If the recipient’s bank supports the SEPA system, funds will arrive within 1-2 business days
  • If the recipient’s bank only supports the Swift system, funds will arrive within 2-5 business days

Morocco

MAD::Cash

For Cashplus cash pickup requests please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "phone_number": "212537718685"
    // Mandatory; International format preferred
  "reason" => "Remittance payment",
    // Optional; Default value is 'Remittance payment'
  "identity_card_type" => "NI",
    // Optional; Values: "PP": Passport, "NI": National ID
  "identity_card_id" => 'AB12345678'
    // Optional
}

Due to regulatory reasons all senders trying to create MAD::Cash transactions need to have the following details present:

  • "identity_type" => "O" - Values: "O": Other, "PP": Passport, "NI": National ID
  • "identity_number" => "AB12345678"
  • "city_of_birth" => "London"
  • "country_of_birth" => "GB" - ISO 2-letter format
  • "gender" => "M" - Values: "M": Male, "F": Female

Please note that the fields above are generally considered optional for senders for other payment corridors. If you wish to use an existing sender who has some of these fields missing you can provide them alongside the id or external_id field in the sender details. For example:

{
  "transaction": {
      "sender": {
        "external_id": "<id of sender>",
        "gender": "M",
        (...)
      },
      (...)
    }
}

Please note when sending MAD::Cash payments you should subscribe to the recipient.pending webhook, as that will broadcast the payment reference ID the customer need to use to obtain the funds. Example webhook response excerpt:

{
   (...)
   "state":"pending",
   "metadata": {
     "payment_reference":"9M5GJRJUBCY"
   },
   (...)
}

The payment reference can also be provided in the recipient details hash optionally for MAD::Cash in which case it will be used instead of the one we generate. The field you have to provide in the hash is called reference. If you wish to use this functionality, please contact us for more details.

Note For a list of Cashplus pickup points please contact us

West Africa / XOF

XOF::Cash

For Senegalese cash pickup requests there are two payout provider options available:

  1. Wari (default)
  2. Wizall

For Wari cash pickup requests please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "phone_number": "774044436", // local Senegalese format
  "cash_provider": "wari" // Optional
}

Please note when sending Wari cash pickup requests you should subscribe to the recipient.pending webhook, as that will broadcast the payment reference ID the customer need to use to obtain the funds. Example webhook response excerpt:

{
   (...)
   "state":"pending",
   "metadata": {
     "payment_reference":"9M5GJRJUBCY"
   },
   (...)
}

The payment reference can also be provided in the recipient details hash optionally for Wari cash pickup requests in which case it will be used instead of the one we generate. The field you have to provide in the hash is called reference. If you wish to use this functionality, please contact us for more details.

For Wizall cash pickup requests please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "phone_number": "774044436", // local Senegalese format
  "identity_card_id": "2231324232", // Mandatory
  "identity_card_type": "PP", // Mandatory; Values: "PP": Passport, "NI": National ID
  "cash_provider": "wizall" // Mandatory
}

XOF::Mobile

For Senegalese mobile payments please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "mobile_provider": "orange", // "orange" or "tigo"
  "phone_number": "774044436" // local Senegalese format
}

The valid mobile_provider values are:

orange
tigo

XOF::Bank

For West African bank payments in selected countries please use the following:

"details" : {
  "first_name": "First",
  "last_name": "Last",
  "bank_name": "BRM",
  "iban": "SN08SN0000000000000000000000",
  "bank_country": "SN" // "SN" or "BJ"
}

The valid bank_country values are:

SN
BJ

Note XOF::Bank payouts are currently in beta phase. At this time, we offer payouts to accounts in Senegal and Benin only.

SouthAfrica

ZAR::Bank

For South African bank payments please use:

"details": {
  "first_name": "First",
  "last_name": "Last",
  "street": "14 Main Street", // should include house number as well
  "postal_code": "AB0001",
  "city": "Cape Town",
  "email": "recipient@email.com", // optional, but highly recommended
  "bank_code": "334810",
  "bank_account": "12345678",
  "phone_number": "+27119785313",
  "transfer_reason_code": "185"
}

The current banks supported and their bank_codes values are:

Standard Bank: 051001
First National Bank: 250655
ABSA: 632005
Nedbank: 198765
Investec: 580105
Capitec Bank: 470010
Bank of Athens: 410506
Bidvest Bank: 462005
African Bank: 430000
Mercantile Bank: 450905
SA Post Office: 460005
Tyme Bank: 678910
Ubank: 431010
Discovery Bank: 679000
Bank Zero: 888000

List of transfer reasons and corresponding transfer_reason_code are:

Sending money into my own account: 183
Donations and gifts: 184
Sending money to a friend, family member or any third party person: 185
Mortgage repayments: 186
Business Travel Payments: 187
Personal Travel Payments: 188
Tuition fees: 189
Investment into property by a foreign individual: 192
Investment by a foreign individual - other: 193
Legal services: 196
Accounting services: 197
Management consulting services: 198
Advertising & market research services: 200
Managerial services: 201
Cultural and recreational services: 205
Salary paid to South African Resident Temporarily Abroad: 206
Salary paid to a non-resident employee in South Africa: 207
Salary paid to a foreign national contract worker in South Africa: 208
Pensions: 213
Annuities: 214
Inheritances: 215
Alimony: 216
Tax - Income tax: 217
Tax - VAT refunds: 218
Tax - Other: 219
Dividends: 222
Commission or brokerage: 224
Rental: 225
Income earned abroad by a resident on an individual investment: 226
Architectural, engineering and other technical services: 245
Payments for data, news related and news agency fees: 249
Computer-related services including maintenance, repair and consultancy: 279
Proceeds for other business services not included elsewhere: 309

Please note that due to regulatory reasons senders trying to create ZAR::Bank transactions are required to have the following fields on the sender present: street, city and postal_code

Note To accept payments in South Africa the recipient has to sign a mandate form online. The link to the form will be sent over the recipient’s mobile phone number and email address, and have to be filled out online. Once the mandate is signed it is valid for one year and the recipient doesn’t need to do these steps again. When sending funds to the same recipient please make sure their name and bank details are the same, otherwise they might be asked to sign the mandate form again.

Warning ZAR::Bank payouts are currently in beta phase.


Improve this page