search

Payout Bank Codes

For all countries/currencies where EllyPay supports bank payouts, there's need to specify the unique code for the bank to which the funds are to be sent. These codes are available via the API

The bank codes are attached to the respective payment providers designated for paying out funds to the supported banks. Therefore, a provider code, obtained from here can be used to query the list of supported banks. Any provider that supports BANK payouts will have the list of banks and respective codes.

hashtag
Get Payout Banks List

GET https://gwapisdbx.ellypayapp.com/data/payout-bank-codes

Returns the list of payout banks based on the provider code

hashtag
Query Parameters

Name
Type
Description

provider_code*

String

The payment provider code for the provider whose bank codes are required

hashtag
Headers

Name
Type
Description

public-key*

String

The merchant account Public Key

hashtag
Sample Banks List Request

curl https://gwapisdbx.ellypayapp.com/data/payout-bank-codes?provider_code=bank_ug
   -H "Accept: application/json" \
   -H "x-api-version: 1" \
   -H "public-key: your-public-key"
{
    "code": 200,
    "status": "success",
    "message": "Request completed successfully.",
    "data": {
        "payout_banks": [
            {
                "bank_name": "Stanbic Bank Uganda",
                "bank_code": "stanbic_bank_ug",
                "is_active": true
            },
            {
                "bank_name": "Guaranty Trust Bank",
                "bank_code": "gtbank_ug",
                "is_active": true
            }
        ]
    }
}
Parameter
Type
Description

bank_code

string

The unique code for the payout bank. It is required for the bank payout transaction requests

bank_name

string

The name of the bank

is_active

string

Whether or not the bank is active for transactions

PreviousPayment OptionsNextTransaction Status Verification

Last updated