Lookups

Get States

Retrieves a list of regions (states or provinces) within a specified country, optionally filtered by CountryID.

get/v1/states

Request

Base URL
https://example.com:443
Auth
none required
TypeScript
https://skmtc.dev/nayax/apis/nayax-cortina-api/docs/v1/states/get.ts
A function with typed inputs. Its response is checked against the schema.

CountryIDinteger

The unique identifier of the country to filter the regions.

A list of regions matching the specified criteria.

RegionIDinteger nullable

The unique identifier of the region.

RegionNamestring nullable

The name of the region.

ShortRegionstring nullable

The abbreviated name or code for the region.

CountryIDinteger nullable

The unique identifier of the country to which the region belongs.

No recorded changes to this operation across all 1 revision of this API.