Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB
Payout Catalog

Returns list of alternative service to a provided service

This GET endpoint is used to retrieve a list of alternative services to a provided service. <br> You can use this endpoint to obtain information about other available services and pricing offered by different companies for a particular destination. <br> To use this endpoint, you need to provide the destination_token as a required parameter in the URL Path. <br> The response will include a JSON array containing details for each company, including the company name, available alternative services, and pricing.

get/payout/service/{destination_token}/alternatives

Path parameters

destination_tokenstring required

Destination token

Query parameters

destination_currencystring
Example:USD

When provided, only return destination tokens that support the destination_currency

show_dynamic_tokens_onlyboolean

Set this parameter to true to display only dynamic tokens, excluding none dynamic ones.

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

Successful operation.

country_codestring required

Country code ISO_3166

delivery_type'CASH_PICKUP' | 'BANK_DEPOSIT' | 'HOME_DELIVERY' | 'MOBILE_WALLET' | 'MASSPAY_CARD' | 'PAPER_CHECK' | 'BILL' | 'CRYPTOCURRENCY' required

The type of service. I.e. cash pickup, home delivery, etc.

Example response

{
  "country_code": "MEX",
  "payers": [
    {
      "destination_token": "123e4567-e89b-12d3-a456-426614174000",
      "payer_logo": "U3dhZ2dlciByb2Nrcw==",
      "payer_name": "Elektra",
      "exchange_rate": [
        {
          "currency_symbol": "MXN",
          "exchange_rate": 18.37
        }
      ],
      "fee": 8,
      "max_limit": 10000,
      "source_amount": 104.3,
      "number_of_locations": 13007,
      "estimated_availability": "2020-07-21T17:32:28Z",
      "additional_description": "Requires drivers license to pickup funds"
    }
  ]
}