---
title: "Gets a list of Companies and their service offerings for the given country code."
method: GET
path: "/payout/country/{country_code}/detailed"
tags: ["Payout Catalog"]
---

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

`GET /payout/country/{country_code}/detailed`

This **GET** endpoint is used to retrieve a list of all companies and their 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. <br> To use this endpoint, you need to provide the `country_code` in the URL Path. <br> The response will include a JSON array containing details for each company, including the company name, service offerings, and pricing.

## Path parameters

- `country_code` string, required

## Query parameters

- `amount` string
- `limit` number, float
- `wallet_token` string, uuid
- `include_payer_logos` boolean
- `user_token` string
- `source_currency` string
- `payer_name` string
- `destination_currency` string
- `only_generic_payers` boolean

## Headers

- `Idempotency-Key` string

## Response `200`

Successful operation.

- CompaniesResp
  - `companies` Company[], required
    - `company_logo` string, byte, required — base64 representation of the company logo
    - `services` Service[], required
      - `country_code` string, required — Country code [ISO_3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)
      - `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.
      - `payers` object[], required
        - `destination_token` string, uuid, required — Token that represents the payout destination. 36 characters long
        - `payer_logo` string, byte — base64 representation of the payer logo
        - `payer_name` string, required — Name of payer
        - `exchange_rate` object[], required — Lists all available currencies and their estimated rates
          - `currency_symbol` string, required — Using [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) format.
          - `exchange_rate` number, double, required — Estimated rate
        - `fee` number, double, required — Service fee
        - `max_limit` number, double, required — The maximum amount (inclusive) the user can send with this service. 0 if no upper limit
        - `min_limit` number, double, required — The minimum amount (inclusive) the user can send with this service. 0 if no lower limit
        - `source_amount` number, double — Optional return field. Will only show if `limit` parameter is provided
        - `number_of_locations` integer — Total number of locations. Mostly relevant for cash pickup services. 0 if unknown or irrelevant
        - `estimated_availability` string, date-time — Estimated availability of funds. When funds would be available to pickup/deposited
        - `additional_description` string — When available, additional description that explains the service offered or requirements for funds delivery.
        - `is_dynamic_token` boolean, required — When set to true, it indicates that this destination_token will auto retry the transaction for a set time until it is successful or timesout. False value means the transaction will be processed by the payer in real-time with instant feedback on success/failure.
        - `is_variable_fee` boolean, required — Indicates whether the fee is variable. When set to true, you can expect the fee to change based on the `source_amount`. Although certain crypto currencies's fee can vary due to network fee flactuation, they are not considered a variable fee as MassPay's fee is not variable based on the `source_amount`.
        - `is_generic` boolean, required — Indicates whether the payer is generic. When true, institution-specific details are provided dynamically via attributes rather than being tied to a predefined institution configuration.
    - `rating` number, required — Overall rating of provider calculated from feedback provided by users from previous trasnactions
    - `description` string, required — A short description of the company
    - `company_name` string, required — The company name

## Other responses

- `400` — Bad request.
- `401` — Unauthorized.
- `403` — Forbidden.
- `404` — Not found.
- `405` — Method Not Allowed.
- `500` — Internal server error.
- `504` — Gateway Time-out.

---

[API](https://skmtc.net/masspay/apis/masspay-api.md) · [All operations](https://skmtc.net/masspay/apis/masspay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/masspay/masspay-api/revisions/c03b61a6a551/schema)