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.

Details

Field	Type	Description
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

Request Sample

curl -X GET {{url}}/v2/payers \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'

Response Sample

{
    "results": [
        {
            "id": 1,
            "name": "Acme - REPUBLIC OF ARMENIA",
            "country": "ARM",
            "website": "",
            "delivery_method": "CASH_PICKUP"
        },
        {
            "id": 2,
            "name": "Acme ",
            "country": "ARM",
            "website": "",
            "delivery_method": "HOME_DELIVERY"
        },
        {
            "id": 3,
            "name": "Acme",
            "country": "KEN",
            "website": "",
            "delivery_method": "WALLET"
        }
    ],
    "paging": {
        "total_count": 3
    }
}

Get Payers by Country

This API provides specific payers in a country

GET /v2/payers?country={{country}}

Parameters

Field	Required	Type	Description
country	No	string	3 character country code

Request Sample

curl -X GET {{url}}/v2/payers?country=KEN \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'

Response Sample

{
            "id": 45,
            "name": "Thunes",
            "country": "KEN",
            "delivery_method": "WALLET"
}

Get Payers by ID

This API provides specific payer with the provided ID

GET /v2/payers/{{payerId}}

Parameters

Field	Required	Type	Description
payerId	Yes	long	Payer ID

Request Sample

curl -X GET {{url}}/v2/payers/{{payerId}} \
  -H 'Accept: application/json' \
  -H 'X-Client-Id: clientid' \
  -H 'X-Client-Secret: clientsecret'

Response Sample

{
    "id": 1,
    "name": "Acme - REPUBLIC OF ARMENIA",
    "receiving_currency": "USD",
    "code": "ARM0001",
    "country": "ARM",
    "address": "Payer Address",
    "phone_number": "[phone]",
    "website": "",
    "network_limit": [],
    "delivery_method": "CASH_PICKUP"
}