PaaS API Docs
Search…
⌃K

Get Payers

Read on populating payers available for payout
Payers are bill payment, cash pickup, and home delivery services in the destination country that is enabled for you. Based on the payer, there may be requirements for specific information and restrictions on payment amounts. For bill payment transactions, the details of each payer's services and information requirements can be obtained through the catalog.

Get payer list

GET /payers?country={{Country}}&payout_method={{payout_method}}

For example, in order to get payers for Mexico, it will be {Country: MX or MEX} and for India, it will be {Country:IN or IND} and so on.
Request Sample
Response Sample
Cash Pickup
curl --location -g --request GET '{{url}}/payers?country=GH&delivery_method=CASH_PICKUP' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
Wallet
curl --location -g --request GET '{{url}}/payers?country=GH&delivery_method=WALLET' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
Cash Pickup
[
{
"country": "GH",
"delivery_method": "CASH_PICKUP",
"id": 6,
"name": "Express Union",
"pickup_location": []
},
{
"country": "GH",
"delivery_method": "CASH_PICKUP",
"id": 7,
"name": "WARI",
"pickup_location": []
},
{
"country": "GH",
"delivery_method": "CASH_PICKUP",
"id": 8,
"name": "Wizall",
"pickup_location": []
},
{
"country": "GH",
"delivery_method": "CASH_PICKUP",
"id": 9,
"name": "Zeepay",
"pickup_location": []
}
]
Wallet
[
{
"country": "GH",
"delivery_method": "WALLET",
"id": 38,
"name": "Airtel Money",
"pickup_location": []
},
{
"country": "GH",
"delivery_method": "WALLET",
"id": 39,
"name": "MTN Mobile Money",
"pickup_location": []
},
{
"country": "GH",
"delivery_method": "WALLET",
"id": 40,
"name": "Tigo Money",
"pickup_location": []
},
{
"country": "GH",
"delivery_method": "WALLET",
"id": 41,
"name": "Vodafone Money",
"pickup_location": []
}
]

Get Payer by ID

If you know the ID of the payer, you can use this endpoint to get the details of the specific payer.

GET /payers/{payerId}

Request Sample
Response Sample
curl --location -g --request GET '{{url}}/payers/38' \
--header 'X-Client-Id: {{client_id}}' \
--header 'X-Client-Secret: {{client_secret}}' \
--header 'Content-Type: application/json'
{
"code": "Airtel Money",
"country": "GH",
"delivery_method": "WALLET",
"id": 38,
"name": "Airtel Money",
"network_limit": [],
"pickup_location": [],
"receiving_currency": "GHS"
}