Skip to content

Get Payment Region List ​

Get payment region list.

Interface Address:

text
/papi/pay/area/list

Request Method:

text
POST

Header Parameters:

ParameterTypeRequiredDescription
X-Access-KeystringYesAPI access key ID. See API Rules for authentication
X-SignaturestringYesSignature value, Base64-encoded HMAC-SHA256 result
X-TimestampstringYesMillisecond-level Unix timestamp (13 digits)
X-NoncestringYesRandom string, 10~32 lowercase letters + digits

Body Parameters:

No request body parameters.

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataarray[object]Return data
├─ codestringRegion code
├─ namestringRegion name
├─ nameEnstringRegion English name
├─ currencyCodestringCurrency code
├─ statusbooleanStatus (0-disabled 1-enabled)
├─ nameI18nobjectInternationalized region name
├─├─ keystringkey
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": [
    {
      "code": "",
      "name": "",
      "nameEn": "",
      "currencyCode": "",
      "status": false,
      "nameI18n": {}
    }
  ],
  "msg": ""
}

OpenAPI Docs