Africa & Middle East

Please see each country below for specific country requirements and example requests.


You need to complete the fields login and pass with yourx_login and x_trans_key credentials. Find them in the Merchant Dashboard, under the Settings > Integration section.


Countries

Algeria
Egypt
Jordan
Lebanon
Morocco
Nigeria
Tanzania
Turkey
Uganda


Algeria

Mandatory parameters - Bank transfers


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryDZ
amountMax. 2 decimal numbers
currencyDZD
bank_account20 chars. First 3 digits must be the bank code. See bank codes below.
addressMax. 200 chars

Example request - Bank Transfer


{
    "login":"1n234n56",
    "pass":"HolAc123o",
    "external_id": "68907654",
    "beneficiary_name": "DLOCAL Algeria",
    "beneficiary_lastname":"LTD",
    "country": "DZ",
    "amount": "1000",
    "currency": "DZD",
    "bank_account": "00799999001977391732",
    "address": "999 Rue xxxx, Algiers",
    "notification_url": "http://google.com",
    "comments":"payment reason",
    "type": "json"
}

Bank Codes


Bank NameBank Code
A B C Corp.014
Al Salam Bank Algeria038
Algeria Gulf Bank032
Arab Bank PLC026
B N P027
Banque Algerienne Developp. Rural003
Banque d'Algerie111
Banque Developpement Local005
Banque Exterieur d'Algerie002
Banque Nationale d'Algerie001
Calyon036
Centre des Cheques Postaux007
City Bank012
CNEP011
CNMA010
CREDIT POPULAIRE D'ALGERIE004
El Baraka006
FransaBank035
Housing Bank AG031
HSBC Algeria037
NATEXIS020
Societe Generale Algerie021
Tresor Central008
Trust Bank029

Mandatory parameters - Mobile Money


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryDZ
amountMax. 2 decimal numbers
currencyDZD
phoneMax. 10 digits - The phone number has to start with 07, 06, 05.

* 07 - Orascom (Djezzy)
* 05 - Ooredoo
* 06 - Mobilis
account_type"mobile"

Example request - Mobile Money


{
    "login":"1n234n56",
    "pass":"HolAc123o",
    "external_id": "68907654",
    "phone": "0734256787",
    "beneficiary_name": "DLOCAL Algeria",
    "beneficiary_lastname":"LTD",
    "country": "DZ",
    "amount": "1000",
    "currency": "DZD",
    "account_type":"mobile",
    "notification_url": "http://google.com",
    "type": "json"
}


Egypt

Mandatory parameters - Bank transfer


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
countryEG
bank_branchBIC code (we accept 8 or 11 Alphanumeric characters in upper case). ​
bank_accountInternational Bank Account Number (IBAN)
See bank codes below.
amountMax. 2 decimal numbers
purpose6 chars
See purpose codes.

Example request - Bank transfer

{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678b",
"beneficiary_name":"KARIM",
"country":"EG",
"bank_name":"",
"bank_branch":"CIBOEGCX",
"bank_account":"EG380019000500000000263180002",
"amount":"245.40",
"address":"Cornish el nil 4455",
"purpose":"ISPAYR",
"currency":"EGP",
"extra_info":"{this_is_extra:2334}",
"notification_url":"https://thisisawebsite.net/payments",
"type":"json"
}

Mandatory parameters - Wallets transfer


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryEG
phoneMax. 13 chars.
Phone can be send either with 11 digits Ex: 01014948646 or with the country code plus 10 digits. Ex: +201014948646.
account_typeOptions: Vodafone, Etisalat, Orange, BankW.
amountMax. 2 decimal numbers

Example request - Wallet


{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"7855443",
"beneficiary_name":"KARIM",
"beneficiary_lastname": "Ahan",
"country":"EG",
"phone":"+234567456345",
"amount":"245.40",
"email":"[email protected]",
"currency":"EGP",
"account_type":"Orange" ,
"notification_url":"https://thisisawebsite.net/payments",
"type":"json"
}

Bank codes


These are the bank codes supported in Egypt (positions 5 to 8 in the IBAN to be sent in the bank_account parameter)

Bank NameBank Code
0002Banque Misr
0003National Bank of Egypt
0004Bank of Cairo
0005Bank of Alexandri
0007Egyptain Arab Land Bank
0008Industrial Development Bank of Egypt
0009Agricultural Bank of Egypt
0010Commercial International Bank Egypt
0013Blom Bank Egypt
0014Emirates National Bank of Dubai
0017Suez Canal Bank
0018Al Ahli Bank of Kuwait – Egypt
0019Bank Audi
0020Ahly United Bank
0022Al Baraka Bank Egypt
0023National Bank of Kuwait
0025HSBC
0027ABU DHABI COMMERCIAL BANK” ADCB-Egypt
0029Egyptian Gulf Bank
0030Abu Dhabi Islamic Bank - Egypt
0031The United Bank
0033Misr Iran Development Bank
0034Attijariwafa bank Egypt S.A.E
0035Societe Arab International Bank
0036Credit Agricole Egypt
0037Qatar National Bank QNB
0038HOUSING AND DEVELOPMENT BANK
0040Arab Banking Corporation - Egypt
0042First Abu Dhabi Bank
0043Citibank
0044Arab Bank Egypt
0046Mashreq Bank
0048National Bank of Greece
0056Arab International Bank
0057Arab African International Bank
0058Arab Investment Bank
0059Faisal Islamic Bank Egypt
0061Export Development Bank of Egypt
9003Nasser Social Bank


Jordan

Mandatory parameters - Wallet transfer


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryJO
amountMax. 2 decimal numbers
currencyJOD
account_typeP: phone or A: alias
bank_accountAlphanumeric Max. 45 chars - Mandatory is account type is A (alias)
phone00962XXXXXXXXX (5 digits international code + 9 digits) - Mandatory is account type is P (phone)
metadata“{“wallet“:“Jomopay“}”

Example request - Wallet transfer


{
    "external_id": "68907654",
    "phone": "0096223737849",
    "beneficiary_name": "DLOCAL Jordan",
    "beneficiary_lastname": "Limited",
    "country": "JO",
    "amount": "1",
    "currency": "JOD",
    "metadata": "{"wallet":"Jomopay"}",
    "notification_url": "http://google.com",
    "type": "json"
}


Lebanon

Mandatory parameters - Bank transfers


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryLB
bank_branchSwift code
bank_accountIBAN
bank_branch_nameMax. 100 chars
amountMax. 2 decimal numbers
currencyLBP or USD

Example request - Bank transfers


{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678",
"beneficiary_name":"JUAN",
"beneficiary_lastname":"NASCIMENTO",
"country":"LB",
"bank_branch":"ALCVLBBE",
"bank_account":"LB62 0999 0000 0001 0019 0122 9114",
"bank_branch_name":"ALBARAKA BEIRUT",
"comments":"this is the 1st comment",
"notification_url":"https://thisisawebsite.net",
"amount":"1100.00",
"currency":"LBP",
"type":"json"
}

Mandatory parameters - Wallet


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryLB
amountMax. 2 decimal numbers
metadata“{“Wallet“:“Hawele“}”
phoneCountry code (+961 ) and 7 to 8 numbers
emailMax. 100 chars

Example request - Wallet


{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678",
"beneficiary_name":"JUAN",
"beneficiary_lastname":"NASCIMENTO",
"country":"LB",
"amount":"1100.00",
"currency":"LBP",
"accont_type":"hawele",
"email":"[email protected]",
"phone":"+96145678976"
}


Morocco

Mandatory parameters


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryMA
bank_accountRIB length 24 digits
See bank codes below.
amountMax. 2 decimal numbers
addressMax. 200 chars

Example request


{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678b",
"beneficiary_name":"JUAN",
"beneficiary_lastname":"PEREZ",
"country":"MA",
"bank_account":"007787001988877665431292",
"amount":"2977.89",
"comments":"this is the 1st comment",
"currency":"MAD",
"address":"14 Boulevard Al Massira Al Khadra",
"extra_info":"{this_is_extra:2334}",
"notification_url":"https://thisisawebsite.net/payments",
"type":"json"
}

Bank account validations


ValidationTypeLengthTypeVerification
Bank accountRIB24numericValidate length

Bank codes


These are the bank codes supported in Morocco (positions 1 to 3 in the RIB to be sent in the bank_account parameter)

Bank NameBank Code
001BANK AL-MAGHRIB
002ARAB BANK
003CAIXA
005UMB
007AWB
011BMCE
013BMCI
019EX-WAFA BANK
021CDM
022SGMB
023ABN AMRO
025BMAO
026UNIBAN
028CITI BANK
031SMDC
045BANK AL AMAL
050CFM
054CDG CAPITAL
060CDG
070BANCO SABADELL
101BANQUE POPULAIRE CENTRE SUD
105BANQUE POPULAIRE EL HOUCEIMA
109BANQUE POPULAIRE BENI MELLAL
117BANQUE POPULAIRE EL JADIDA SAFI
121BANQUE POPULAIRE ERRACHIDIA
127BANQUE POPULAIRE FES TAZA
130BANQUE POPULAIRE JADIDA
133BANQUE POPULAIRE GHARB
140BANQUE POPULAIRE KHOURIBGA
143BANQUE POPULAIRE LAAYOUNE
145BANQUE POPULAIRE MARRAKESH BENI MELLAL
148BANQUE POPULAIRE MEKNES
150BANQUE POPULAIRE NADOR EL HOCEIMA
155BANQUE POPULAIRE OUARZAZATE
157BANQUE POPULAIRE OUJDA
159BANQUE POPULAIRE SAFI
163BANQUE POPULAIRE BERKANE
164BANQUE POPULAIRE TANGER TETOUAN
169BANQUE POPULAIRE TAZA
172BANQUE POPULAIRE TETOUAN
175BANQUE POPULAIRE TIZNIT
178BANQUE POPULAIRE CASABLANCA
181BANQUE POPULAIRE RABAT KENITRA
190BCP
195BANQUE POPULAIRE CASA EST
197BANQUE POPULAIRE CASA SUD
205BNDE
225CAM
230CIH BANK
310TGR
350AL BARID BANK
360UMNIA BANK
361BMCI NAJMAH
362BANK ASSAFA
363DAR AL AMANE
364ARREDA
365AL AKHDAR BANK
366BANK AL YOUSR
367BANK AL TAMWEEL WA AL INMA


Nigeria

Mandatory parameters


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryNG
bank_codeSee bank codes below.
bank_accountSee bank account validations below.
amountMax. 2 decimal numbers
currency_to_payUSD
Mandatory only if the payout needs to be paid in USD.

In case this parameter is missing, the payout will be paid in local currency.
phoneMax. 15 chars
Mandatory only if the payout needs to be paid in USD.

Example request - NGN currency


{
"external_id":"1234567812345678",
"beneficiary_name":"Daniela",
"beneficiary_lastname":"Perez",
"country":"NG",
"amount":"4316.50",
"bank_code":"001",
"bank_account":"1234567891",
"currency":"NGN",
"comments":"this is the 1st comment",
"login":"1n234n56",
"pass":"HolAc123o",
}

Example request - USD currency


{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678",
"beneficiary_name":"Daniela",
"beneficiary_lastname":"Perez",
"country":"NG",
"amount":"4316.50",
"bank_code":"001",
"bank_account":"1234567891",
"currency":"USD",
"phone":"250700800900",
"comments":"this is the 1st comment",
"currency_to_pay":"USD"
}

Bank account validations


ValidationNameLengthTypeVerification digit
AccountNUBAN10numericApply verification algorithm

Bank codes


The payout will be paid in local currency unless the currency_to_pay param is specified.

Bank NameBank CodeSupport NGN currencySupport USD currency
ACCESS BANK NIGERIA LTD044
CENTRAL BANK OF NIGERIA001
CORONATION MERCHANT BANK559
DIAMOND BANK LTD063
ECOBANK NIGERIA PLC050
FBNQuest Merchant Bank Limited060002
FIDELITY BANK PLC070
FINATRUST MICROFINANCE BANK608
FIRST BANK OF NIGERIA PLC011
FIRST CITY MONUMENT BANK214
FSDH MERCHANT BANK LIMIT601
GUARANTY TRUST BANK PLC058
HASAL MICROFINANCE BANK090121
HERITAGE BANK030
IBILE MFB090118
JAIZ BANK PLC301
KEYSTONE BANK LTD082
New Prudential Bank561
NIGERIA INTERNATIONAL BANK (CITIBANK)023
NPF Microfinance Bank552
PAGA327
Page MFBank560
PARALLEX MFB526
PROVIDUS BANK101
RAND MERCHANT BANK502
SKYE BANK PLC076
STANBIC IBTC BANK PLC221
STANDARD CHARTERED BANK NIGERIA LTD068
STERLING BANK PLC232
SUNTRUST BANK100
UNION BANK OF NIGERIA PLC032
UNITED BANK FOR AFRICA PLC033
UNITY BANK PLC215
WEMA BANK PLC035
ZENITH INTERNATIONAL BANK LTD057


Tanzania

Mandatory parameters - Wallet


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
document_idMax. 100 chars
document_typePASS - Passport
NI - National ID
MIL - Military
countryTZ
amountMax. 2 decimal numbers
account_type“mobile"
phone+255 + mobile phone number (9 digits)
currencyTZS

Example request - Wallet


{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678",
"beneficiary_name":"JUAN",
"beneficiary_lastname":"NASCIMENTO",
"country":"TZ",
"amount":"1100.00",
"currency":"TZS",
"account_type":"mobile",
"phone":"+255222117730",
"document_id":"6896986969",
"document_type":"NI",
}


Turkey

Mandatory parameters


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
countryTR
bank_accountMax. 26 chars
amountMax. 2 decimal numbers
phoneMax. 20 chars

Example request


{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678b",
"beneficiary_name":"RUDRAH",
"beneficiary_lastname":"HASHIMI",
"country":"TR",
"bank_account":"1234567891772",
"amount":"2064.00",
"phone":"902125551212",
}

Bank account validations


ValidationTypeLengthTypeVerification
Bank accountIBAN26CharactersIBAN algorithm


Uganda

Mandatory parameters - Wallet


Mandatory parameterDescription
login32 chars
pass32 chars
external_idMax. 100 chars
beneficiary_nameMax. 50 chars
beneficiary_lastnameMax. 50 chars
document_idMax. 100 chars
document_typePASS - passport
NI - national_id
MIL - military
countryUG
amountMax. 2 decimal numbers
account_type“mobile”
phone+256 + mobile phone number (9 digits)
currencyUGX

Example request - Wallet


{
"login":"1n234n56",
"pass":"HolAc123o",
"external_id":"1234567812345678",
"beneficiary_name":"JUAN",
"beneficiary_lastname":"NASCIMENTO",
"country":"UG",
"amount":"1100.00",
"currency":"UGX",
"account_type":"mobile",
"phone":"+256712321232",
"document_id":"6896986969",
"document_type":"NI",
}

Did this page help you?