Skip to content

Payment Order Page Query ​

Payment order page query.

Interface Address:

text
/papi/order/page

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
pageNointegerNoPage number, starting from 1, default 1
pageSizeintegerNoItems per page, maximum 1000, default 10
productTypeintegerNoProduct type
payStatusintegerNoPayment status (1-pending, 2-success, 3-failed)
orderStatusintegerNoOrder status (1-pending, 2-processing, 3-completed, 4-cancelled)
optTypeintegerNoOrder operation type
resTypeintegerNoIP order resource type (only effective when productType is IP)
createTimearray[integer]NoPayment time

Request Example:

json
{
  "pageNo": 1,
  "pageSize": 10
}

Response Parameters:

ParameterTypeDescription
codeintegerError code. See Error Codes
dataobjectResponse data
├─ listarray[object]Data list
├─├─ merchantOrderIdstringMerchant order ID
├─├─ orderNostringOrder number
├─├─ productTypeintegerProduct type
├─├─ optTypeintegerOperation type
├─├─ payStatusintegerPayment status
├─├─ orderStatusintegerOrder status
├─├─ payTimeintegerPayment application time
├─├─ ctimeintegerCreation time
├─├─ desstringDescription
├─├─ payUrlstringPayment URL
├─├─ currencystringCurrency type
├─├─ resTypeintegerResource type (IP order only)
├─ totalintegerTotal count
msgstringError message

Response Example:

json
{
  "code": 0,
  "data": {
    "list": [
      {
        "merchantOrderId": "",
        "orderNo": "",
        "productType": 0,
        "optType": 0,
        "payStatus": 0,
        "orderStatus": 0,
        "payTime": 0,
        "ctime": 0,
        "des": "",
        "payUrl": "",
        "currency": "",
        "resType": 0
      }
    ],
    "total": 0
  },
  "msg": ""
}

Wallet payment rules ​

Wallet payment uses payCode=WALLET and providerCode=INTERNAL. Mixed payment uses the actual online channel plus an integer walletPayAmount in USD cents, greater than zero and below the calculated payable total; do not submit onlinePayAmount. Recharge orders cannot use wallet or mixed payment. On timeout or uncertain payment status, query the original order and transactions before retrying. Cancellation or switching to wallet payment requires reliable confirmation that an existing online payment is closed. Wallet deductions are returned against the original transaction when cancellation is permitted.

OpenAPI Docs