Mandatory parameters - Bank transfers

Mandatory parameterDescriptionFlow type
login32 charsALL
pass32 charsALL
external_idMax. 100 charsALL
beneficiary_nameMax. 50 charsALL
beneficiary_lastnameMax. 50 charsALL
countryKEALL
bank_branchSWIFT code (we accept 8 or 11 alphanumeric characters in upper case)ALL
bank_accountMin. length 8 and Max. length 20ALL
amountMax. 2 decimal numbersALL
currencyKESALL
purposeEPREMT - Remittance (C2C)
EPBTOB - Business to Business (B2B)
C2C, B2B
remitter_fullnameMax. 200 chars
Mandatory only for remittance (C2C)
C2C
remitter_documentMax. 45 chars
Mandatory only for remittance (C2C)
C2C
remitter_birth_dateFormat 'YYYYMMDD'
Mandatory only for remittance (C2C)
C2C
remitter_addressMax. 200 chars
Mandatory only for remittance (C2C)
C2C
remitter_cityMax. 40 chars
Mandatory only for remittance (C2C)
C2C
remitter_countryISO 3166-1 alpha-2 code
Mandatory only for remittance (C2C)
C2C
remitter_document_type'ID' for national identification number
'PASS' for passport
Mandatory only for remittance (C2C)
C2C
remitter_nationalityISO 3166-1 alpha-2 code
Mandatory only for remittance (C2C)
C2C

Example request

{
    "login":"1n234n56",
    "pass":"HolAc123o",
    "external_id": "68907654",
    "beneficiary_name": "Jhon",
    "beneficiary_lastname": "Miles",
    "country": "KE",
    "amount": "100",    
    "currency": "KES",
    "bank_branch": "BARCKENX",
    "bank_account": "KE94CBJO0010000000000131000301",
    "notification_url": "https://thisisawebsite.net/payments",
    "type": "json"
}

Mandatory parameters - Wallet transfers

Mandatory parameterDescriptionFlow type
login32 charsB2C, C2C
pass32 charsB2C, C2C
external_idMax. 100 charsB2C, C2C
beneficiary_nameMax. 50 charsB2C, C2C
beneficiary_lastnameMax. 50 charsB2C, C2C
countryKEB2C, C2C
amountMax. 2 decimal numbersB2C, C2C
account_typePossible options: MPESA, AIRTEL, EQUITEL B2C, C2C
phone+254 + mobile phone number (9 digits)B2C, C2C
currencyKESB2C, C2C
purposeEPREMT - Remittance (C2C)
Mandatory only for remittance (C2C)
C2C
remitter_fullnameMax. 200 chars
Mandatory only for remittance (C2C)
C2C
remitter_documentMax. 45 chars
Mandatory only for remittance (C2C)
C2C
remitter_birth_dateFormat 'YYYYMMDD'
Mandatory only for remittance (C2C)
C2C
remitter_addressMax. 200 chars
Mandatory only for remittance (C2C)
C2C
remitter_cityMax. 40 chars
Mandatory only for remittance (C2C)
C2C
remitter_countryISO 3166-1 alpha-2 code
Mandatory only for remittance (C2C)
C2C
remitter_document_type'ID' for national identification number
'PASS' for passport
Mandatory only for remittance (C2C)
C2C
remitter_nationalityISO 3166-1 alpha-2 code
Mandatory only for remittance (C2C)
C2C

Example request

{
    "login":"1n234n56",
    "pass":"HolAc123o",
    "external_id": "68907654",
    "beneficiary_name": "Jhon",
    "beneficiary_lastname": "Miles",
    "country": "KE",
    "amount": "1",    
    "currency": "KES",
    "account_type": "MPESA",
    "phone": "+294123456789",
    "notification_url": "https://thisisawebsite.net/payments",
    "type": "json"
}