Payers
Read on retrieving available payers
Payers are the entities that deliver the transaction to the recipient in recipient's country. A payer is associated with the destination country and supports one of the following delivery methods:
CASH_PICKUP
HOME_DELIVERY
WALLET
The payer id is required for creating transactions with delivery_method as CASH_PICKUP
and HOME_DELIVERY
. Here, the recipient can collect the transferred amount from any of the payer's location in the country when the delivery_method is CASH_PICKUP
or HOME_DELIVERY
.
The payer id is also required when adding recipient's wallet account. The recipient's wallet account needs to be associated with the wallet payers.
id
long
ID of the payer
name
string
Name of the Payer
country
string
3-character ISO code of the country
code
string
Payer Code
address
string
Address of the Payer.
phone_number
string
Contact number of the Payer
website
string
Website of the Payer
network_limit
string
Transaction limit of the Payer
delivery_method
string
Delivery method of the Payer
Get All Payers
This API provides list of payers available for you.
GET /v2/payers
Get Payers by Country
This API provides specific payers in a country
GET /v2/payers?country={{country}}
country
No
string
3 character country code
Get Payers by ID
This API provides specific payer with the provided ID
GET /v2/payers/{{payerId}}
payerId
Yes
long
Payer ID
Last updated