v1

latestOpenAPI 3.0.1Apache 2.02026-07-248286406.8 KB

Payout Catalog

Gets a list of Companies and their best service offerings for the given country code.

This GET endpoint is used to retrieve a list of companies and their best service offerings for a specific country. <br> You can use this endpoint to obtain information about available services and pricing for each respected company in the provided country. If two providers offer similar services, only the cheapest option will be displayed. <br> To use this endpoint, you need to provide the country_code 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, cheapest service offerings, and pricing.

get/payout/country/{country_code}/best

Path parameters

country_codestring required

Country code searching services for. 3 letters ISO_3166 code"

Query parameters

amountnumber float

Returns the results fee based on the given amount, defaults to $200

limitnumber float

Limit amount for transaction amount + fee. If fee + amount are higher than the limit, the output will automatically adjust to maximize the possible amount sent

wallet_tokenstring uuid

Token representing the wallet used. If provided, the results would be custom-tailored to this user.

include_payer_logosboolean

Example:true

Whether to include the payers logo in base64 format.

user_tokenstring

Token representing the user for which we fetch the catalog. If provided, the results would be custom-tailored to this user. Not necessary if wallet_token is provided

source_currencystring

Required if amount is provided. The currency associated with the amount

payer_namestring

Filter services that match payer name. Multiple payer names can be passed using pipe (|) as a separator

destination_currencystring

Filter services that support the destination currency

only_generic_payersboolean

Filter out country-specific service variations and return only the generic option. For example, for bank deposits, exclude individual bank listings and include only the general bank deposit option

Headers

Idempotency-Keystring

Unique key to prevent duplicate processing

Response

Successful operation.

Example response

{
  "companies": [
    {
      "company_logo": "U3dhZ2dlciByb2Nrcw==",
      "services": [
        {
          "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"
            }
          ]
        }
      ],
      "rating": 4.5,
      "description": "MassPay is a top leading provider with over 10 years of industry experience",
      "company_name": "MassPay"
    }
  ]
}