Skip to content

Get Payment Methods ​

Get payment methods.

Interface Address:

text
/papi/pay/payWayList

Request Method:

text
POST

Content-Type:

text
application/json

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:

ParameterTypeRequiredDescription
areaCodestringYesRegion code

Request Example:

json
{
  "areaCode": "HK"
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataarray[object]Return data
├─ codestringPayment method code
├─ namestringPayment name
├─ providerCodestringProvider code
├─ typeintegerType (1-WeChat 2-Alipay, etc.)
├─ imagestringImage
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": [
    {
      "code": "",
      "name": "",
      "providerCode": "",
      "type": 0,
      "image": ""
    }
  ],
  "msg": ""
}

OpenAPI Docs