Skip to main content
GET
/
v1
/
platform
/
international
/
catalogues
List Reference Data
curl --request GET \
  --url https://api-sandbox.finogates.com/v1/platform/international/catalogues \
  --header 'Authorization: Bearer <token>'
{
  "status_code": 123,
  "data": "<unknown>",
  "query_generated_time": 123
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
type
enum<string>
required

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.
Available options:
countries,
states,
cities,
currencies,
document-types,
account-types,
business-types
​
country_id
integer | null

The ID of the country (from type=countries). Required when type=states or type=cities.

​
state_id
integer | null

The ID of the state or region (from type=states). Required when type=cities.

Response

Successful Response

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.

​
status_code
integer
required

HTTP status code for the response.

​
data
any
required

Payload or error details.

​
query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.