Payers

A payer is the institution or network that delivers the money to the beneficiary. This endpoint returns the active payers, filtered by service, country and currency, with pagination.

Endpoint

GET/api/v1/pay-out/payers

Authentication: HTTP Basic with your API key and secret. See Authentication.

Query parameters

All parameters are optional.

Parameter	Type	Description
country_iso	string	3-letter destination country code, for example COL.
currency	string	Destination currency (ISO 4217), for example COP.
service_slug	string	A slug from Payout services, for example bank-deposit.
page	integer	Page number, from 1.
per_page	integer	Results per page, 1 to 100. Default 100.

country_iso_code is accepted as an alias of country_iso. Codes are case-insensitive.

Example

curl "https://sandbox-api.cashela.com/api/v1/pay-out/payers?service_slug=bank-deposit&country_iso=COL&currency=COP" \
  -u "$CASHELA_API_KEY:$CASHELA_API_SECRET" \
  -H "Accept: application/json"

{
  "success": true,
  "data": {
    "total": 1,
    "per_page": 100,
    "current_page": 1,
    "last_page": 1,
    "from": 1,
    "to": 1,
    "first_page_url": "https://sandbox-api.cashela.com/api/v1/pay-out/payers?page=1",
    "self": "https://sandbox-api.cashela.com/api/v1/pay-out/payers?page=1",
    "last_page_url": "https://sandbox-api.cashela.com/api/v1/pay-out/payers?page=1",
    "next_page_url": null,
    "prev_page_url": null,
    "path": "https://sandbox-api.cashela.com/api/v1/pay-out/payers",
    "data": [
      {
        "id": 123,
        "name": "Example Bank",
        "source": "pay_out_payers",
        "pay_out_payer_id": 123,
        "increment": 0.01,
        "precision": 2,
        "mandatory_branch": false,
        "currency": "COP",
        "country_iso": "COL",
        "country_iso_code": "COL",
        "service": { "id": 2, "slug": "bank-deposit", "name": "Bank deposit", "source": "pay_out_services" },
        "transaction_types": ["C2C"]
      }
    ]
  },
  "message": "Payers retrieved successfully."
}

Payers are sorted by name. Values are illustrative.

Response fields

Pagination fields (total, per_page, current_page, last_page, from, to, next_page_url, prev_page_url and the other URLs) sit next to the data list.

Field	Type	Description
id	integer	Payer ID. Send it as pay_out_payer_id when you execute a transaction, or as payer_id in a quotation to quote only this payer.
pay_out_payer_id	integer	Same value as id.
name	string	Payer name.
source	string	Catalog the payer comes from. Always pay_out_payers.
currency	string	Currency the payer pays out.
country_iso / country_iso_code	string	3-letter country code the payer serves.
service	object	Service of the payer: id, slug, name, source.
increment	number	Amount increment configured for the payer.
precision	integer	Decimal precision configured for the payer.
mandatory_branch	boolean or null	Whether the payer requires branch details.
transaction_types	array or null	Transaction types the payer accepts (C2C, C2B, B2C, B2B).

The response can include other fields. Do not build on fields that are not listed here.

Note

The beneficiary and account fields that each payer needs are not returned by this endpoint. Ask Cashela for the field list of each corridor before you go live. See Execute a transaction.

Errors

Status	When
422	A filter has an unknown value, or per_page is out of range.