Payouts to Kenya
Payout parameters
Name | Mandatory | Type | Description |
---|---|---|---|
payment_method | + | object | Payout data |
type | + | string | Value: bank_account |
bank_account | + | object | Bank account |
system_type | + | string | Value: global |
global | + | object | Bank account details |
description | + | string | Purpose of remittance for the payout. This description should match the classification given in How to specify the remittance purpose |
bank_account_number | + | string | Bank account number for the payout |
participant_details | + | object | Information on the payout participants |
recipient | + | object | Recipient details |
bank_name | + | string | Important: the bank name must be chosen from the List of supported banks, otherwise the payout will fail |
currency | + | string | Recipient's currency in ISO 4217 format. Case insensitive |
country_iso3 | + | string | Recipient's country code (ISO-3166-1 alpha-3) |
first_name | + | string | Recipient's first name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout |
last_name | + | string | Recipient's last name. Important: if the name is passed incorrectly, the recipient bank may not accept the payout |
sender | + | object | Sender details |
company_name | + | string | Sender company name. Limited to 100 characters, cannot contain digits only |
registration_number | + | string | Sender company registration number |
country_iso3 | + | string | Sender’s country code (ISO-3166-1 alpha-3) |
code | + | string | Sender company registration number |
amount_details | + | object | Payout amount details |
amount | + | int | Payout amount in decimal format. The value must be greater than zero. If you are sending 100 USD, write 10000 |
currency | + | string | ISO 4217 currency code. Case insensitive |
Example
curl -X POST \
https://demo.smart-glocal.com/api/v1/session/start/payout \
-H 'Content-Type: application/json' \
-H 'X-PARTNER-PROJECT: your_project_name' \
-H 'X-PARTNER-SIGN: signature' \
-d'{
"session_id": "ps_1053680",
"payment_method": {
"type": "bank_account",
"bank_account": {
"system_type": "global",
"global": {
"iban": "NUMBER_VALUE",
"description": "purpose of remittance"
}
}
},
"participant_details": {
"recipient": {
"bank_name": "Bank name from the list below",
"currency": "kes",
"first_name": "John",
"last_name": "Johnson"
},
"sender": {
"company_name": "Company name",
"registration_number": "1234567890",
"country_iso3": "USA",
"code": "1234567890"
}
},
"amount_details": {
"amount": 1000,
"currency": "usd"
}
}'
List of supported banks
Country | Currency | Bank |
---|---|---|
Kenya | KES | Consolidated Bank of Kenya Limited |
Kenya | KES | ABSA Bank |
Kenya | KES | Bank of Africa Kenya Limited |
Kenya | KES | Diamond Trust Bank Limited |
Kenya | KES | Credit Bank Limited |
Kenya | KES | Stanbic Bank Kenya Limited |
Kenya | KES | NIC Bank Limited |
Kenya | KES | Citibank N A |
Kenya | KES | Jamii Bora Bank |
Kenya | KES | Spire Bank Ltd |
Kenya | KES | Sidian Bank Limited |
Kenya | KES | Guaranty Trust Bank ( Kenya) Ltd. |
Kenya | KES | Kenya Commercial Bank Limited |
Kenya | KES | I&M Bank Limited |
Kenya | KES | Gulf African Bank Ltd |
Kenya | KES | Paramount Universal Bank Limited |
Kenya | KES | Equity Bank Limited |
Kenya | KES | Family Bank Ltd |
Kenya | KES | Middle East Bank Kenya Limited |
Kenya | KES | First Community Bank |
Kenya | KES | KENYA WOMEN MICROFINANCE BANK LT |
Kenya | KES | National Bank of Kenya Limited |
Kenya | KES | Co-operative Bank of Kenya Limited |
Kenya | KES | Prime Bank Limited |
Kenya | KES | NCBA Bank Kenya |
Kenya | KES | Habib Bank A G Zurich |
Kenya | KES | Standard Chartered Bank Kenya Limited |
Kenya | KES | Guardian Bank Limited |