Skip to main content
GET
List Regions

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Query Parameters

country
string
required

Country code (ISO 3166-1 alpha-2, lowercase)

Response

200 - application/json

Successfully retrieved region list (empty array when the country has no regions)

code
integer
required
Example:

200

message
string
required
Example:

"Success"

data
object[]
required