Common

Common query APIs including region list, city list, and mobile area codes.

Region List

Get the list of supported regions (countries).

ItemDetails
EndpointPOST /api/v1/merchant/common/regionList
No request body required, only the ApiKey header.

Response Parameters

FieldTypeDescription
respCodeStringResponse code
respMsgStringResponse message
data[]ArrayRegion list
data[].regionCodeStringRegion/country code, ISO 3166-1 alpha-2
data[].regionNameStringRegion/country name

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": [
    { "regionCode": "CN", "regionName": "China" },
    { "regionCode": "US", "regionName": "United States" },
    { "regionCode": "HK", "regionName": "Hong Kong" }
  ]
}

City List

Query cities under a specified region.

ItemDetails
EndpointPOST /api/v1/merchant/common/cityList

Request Parameters

FieldTypeRequiredDescription

regionCode

String(2)

✅

Region/country code

parentCode

String

—

Parent administrative division code for cascading queries

Request Example

{
  "regionCode": "CN",
  "parentCode": "GD"
}

Response Parameters

FieldTypeDescription
respCodeStringResponse code
respMsgStringResponse message
data[]ArrayCity list
data[].regionCodeStringParent region code
data[].parentCodeStringParent administrative division code
data[].cityCodeStringCity code
data[].cityNameStringCity name

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": [
    {
      "regionCode": "CN",
      "parentCode": "GD",
      "cityCode": "SZ",
      "cityName": "Shenzhen"
    },
    {
      "regionCode": "CN",
      "parentCode": "GD",
      "cityCode": "GZ",
      "cityName": "Guangzhou"
    }
  ]
}

Mobile Area Code List

Get the list of supported mobile area codes.

ItemDetails
EndpointPOST /api/v1/merchant/common/mobileAreaCodeList
No request body required, only the ApiKey header.

Response Parameters

FieldTypeDescription
respCodeStringResponse code
respMsgStringResponse message
data[]ArrayArea code list
data[].regionCodeStringRegion/country code
data[].regionNameStringRegion/country name
data[].areaCodeStringMobile international area code (e.g. +86)

Response Example

{
  "respCode": "20000",
  "respMsg": "success",
  "data": [
    { "regionCode": "CN", "regionName": "China", "areaCode": "+86" },
    { "regionCode": "US", "regionName": "United States", "areaCode": "+1" },
    { "regionCode": "HK", "regionName": "Hong Kong", "areaCode": "+852" }
  ]
}

Cardholders

Cardholder management APIs including creation, update, and query operations.

Transactions

Transaction record query API with filtering by transaction type, status, and time range.