Skip to main content

Get Country

Returns the list of supported countries and zones.

Endpoint​

GET /v1/country/get

Request​

Header Parameters​

ParameterTypeRequiredExampleDescription
AuthorizationstringYesBearer YOUR_ACCESS_TOKENBearer token used for authentication.

Query Parameters​

N/A

Example request​

curl -X GET "${API_URL}/v1/country/get" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Responses​

200 Success​

200 Success

Response schema: application/json
data.country_list
array
List of supported countries.
Expand for item fields.
code
string
Country code
Example: HK
country
string
Country Full Name
Example: HONG KONG

Response sample

{
  "data": {
    "country_list": [
      { "code": "AF", "country": "AFGHANISTAN" },
      { "code": "AU", "country": "AUSTRALIA" },
      { "code": "DE", "country": "GERMANY" },
      { "code": "HK", "country": "HONG KONG" },
      { "code": "US", "country": "USA" }
    ]
  }
}

400 Bad Request​

400 Bad Request

Response schema: application/json
code
string
Error code.
Example: 400000
code_reason
string
Error reason.
Example: BAD_REQUEST
message
string
Human-readable message.
Example: Bad Request

Response sample

{
  "error": {
    "code": "400000",
    "code_reason": "BAD_REQUEST",
    "message": "Bad Request"
  }
}

401 Unauthorized​

401 Unauthorized

Response schema: application/json
code
string
Error code.
Example: 401000
code_reason
string
Error reason.
Example: UNAUTHORIZED
message
string
Human-readable message.
Example: Unauthorized

Response sample

{
  "error": {
    "code": "401000",
    "code_reason": "UNAUTHORIZED",
    "message": "Unauthorized"
  }
}

403 Forbidden​

403 Forbidden

Response schema: application/json
error
json-string
Access forbidden for this resource.

404 Not Found​

404 Not Found

Response schema: application/json
error
json-string
Resource or endpoint not found.

500 Failure​

500 Failure

Response schema: application/json
code
string
Error code.
Example: 500999
code_reason
string
Machine-readable error reason.
Example: API_ERROR
message
string
Human-readable message.
Example: Api Error, please contact customer service

Response sample

{
  "error": {
    "code": "500999",
    "code_reason": "API_ERROR",
    "message": "Api Error, please contact customer service"
  }
}