Payout services

A service is the way the money reaches the beneficiary, for example a bank deposit. This endpoint returns the services that have at least one active payer, optionally for a given country and currency.

Endpoint

GET/api/v1/pay-out/services

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.

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/services?country_iso=COL&currency=COP" \
  -u "$CASHELA_API_KEY:$CASHELA_API_SECRET" \
  -H "Accept: application/json"

{
  "success": true,
  "data": {
    "data": [
      { "id": 2, "slug": "bank-deposit", "name": "Bank deposit", "source": "pay_out_services" }
    ]
  },
  "message": "Services retrieved successfully."
}

The list is nested in data.data. IDs and names are illustrative; read them from the API.

Response fields

Field	Type	Description
id	integer	Service ID. Send it as pay_out_service_id in a quotation to limit the quote to this service.
slug	string	Stable service identifier. Use it as service_slug in countries and payers.
name	string	Display name.
source	string	Catalog the service comes from. Always pay_out_services.

Errors

Status	When
422	country_iso or currency does not exist.