> ## Documentation Index
> Fetch the complete documentation index at: https://developer.finogates.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Reference Data

> Look up a single reference list (a "catalogue") for building international payouts.

Which list you get back is chosen by the `type` query parameter. A few lists
need extra inputs: `states` needs a `country_id`, and `cities` needs both a
`country_id` and a `state_id`. Only one list is returned per request.



## OpenAPI

````yaml GET /v1/platform/international/catalogues
openapi: 3.1.0
info:
  title: Finogate Platform API v1
  version: 0.1.0
servers:
  - url: https://api-sandbox.finogates.com
    description: Sandbox
  - url: https://api.finogates.com
    description: Production
security: []
tags:
  - name: auth
  - name: users
  - name: payees
  - name: verification
  - name: bank accounts
  - name: card processing
  - name: digital-assets
  - name: international
  - name: onboarding
  - name: pending-applications
  - name: wallets
  - name: payments
  - name: catalog
  - name: webhooks
  - name: phone-numbers
  - name: sms
  - name: calls
  - name: listings
  - name: embed-tokens
paths:
  /v1/platform/international/catalogues:
    get:
      tags:
        - international
      summary: List Reference Data
      description: >-
        Look up a single reference list (a "catalogue") for building
        international payouts.


        Which list you get back is chosen by the `type` query parameter. A few
        lists

        need extra inputs: `states` needs a `country_id`, and `cities` needs
        both a

        `country_id` and a `state_id`. Only one list is returned per request.
      operationId: catalogues_v1_platform_international_catalogues_get
      parameters:
        - name: type
          in: query
          required: true
          schema:
            $ref: >-
              #/components/schemas/app__api__routes__providers__more_platform__CatalogueType
            description: >-
              Which reference list to return. Pick exactly one:

              - `countries` — destination countries you can send payouts to.

              - `states` — states or regions within a country (needs
              `country_id`).

              - `cities` — cities within a state or region (needs `country_id`
              and `state_id`).

              - `currencies` — currencies you can send payouts in.

              - `document-types` — ID document types the recipient may use
              (varies by destination country).

              - `account-types` — bank account types you can pay into, such as
              checking or savings (varies by destination country).

              - `business-types` — allowed sender and business types, such as
              business-to-customer, business-to-business, or payroll.

              Only one list is returned per request.
          description: >-
            Which reference list to return. Pick exactly one:

            - `countries` — destination countries you can send payouts to.

            - `states` — states or regions within a country (needs
            `country_id`).

            - `cities` — cities within a state or region (needs `country_id` and
            `state_id`).

            - `currencies` — currencies you can send payouts in.

            - `document-types` — ID document types the recipient may use (varies
            by destination country).

            - `account-types` — bank account types you can pay into, such as
            checking or savings (varies by destination country).

            - `business-types` — allowed sender and business types, such as
            business-to-customer, business-to-business, or payroll.

            Only one list is returned per request.
        - name: country_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              The ID of the country (from `type=countries`). Required when
              `type=states` or `type=cities`.
            title: Country Id
          description: >-
            The ID of the country (from `type=countries`). Required when
            `type=states` or `type=cities`.
        - name: state_id
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
              - type: 'null'
            description: >-
              The ID of the state or region (from `type=states`). Required when
              `type=cities`.
            title: State Id
          description: >-
            The ID of the state or region (from `type=states`). Required when
            `type=cities`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - _AuthenticatedBearer: []
components:
  schemas:
    app__api__routes__providers__more_platform__CatalogueType:
      type: string
      enum:
        - countries
        - states
        - cities
        - currencies
        - document-types
        - account-types
        - business-types
      title: CatalogueType
      description: Which reference list ``GET /catalogues`` returns (one per request).
    CommonResponse:
      properties:
        status_code:
          type: integer
          title: Status Code
          description: HTTP status code for the response.
        data:
          title: Data
          description: Payload or error details.
        query_generated_time:
          type: integer
          title: Query Generated Time
          description: >-
            UTC timestamp (milliseconds since epoch) when response was
            generated.
      type: object
      required:
        - status_code
        - data
        - query_generated_time
      title: CommonResponse
      description: |-
        Standard response wrapper for single-object responses and errors.

        Generic over the payload type. A route that declares
        ``CommonResponse[SomeModel]`` gets the real ``data`` schema rendered in
        OpenAPI/Swagger; a bare ``CommonResponse`` leaves ``data`` untyped.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    _AuthenticatedBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /v1/platform/auth/token

````