Request Body Parameters

application/json

Common Request Parameters

bizContent

• merchantTransactionIdString(64)Conditional

  Merchant transaction ID, required if transactionId is not provided
• transactionIdString(64)Conditional

  PingPong transaction ID, required if merchantTransactionId is not provided

请求报文示例

{
  "accId": "PPX_ACC_202312001",
  "clientId": "PPX_MCH_20230001",
  "signType": "SHA256",
  "sign": "9F86D081884C7D659A2FEAA0C55AD015A3BF4F1B2B0B822CD15D6C15B0F00A08",
  "version": "1.0",
  "event": "PAY_QUERY",
  "requestTime": "1683532500000",
  "bizContent": {
    "merchantTransactionId": "MCH_ORDER_20231212001"
  }
}

Responses Body Parameters

application/json

Common Response Parameters

bizContent

• cardTransinfoObjectOptional

  Card payment information, returned only for card payments

  • acqBankNameStringOptional

    POS card transaction acquiring bank name
  • acqTermnialIdStringOptional

    POS card transaction acquiring terminal ID
  • acqMerchantIdStringOptional

    POS card transaction acquiring merchant ID
  • acqRRNStringOptional

    POS card transaction acquiring RRN (Retrieval Reference Number)
  • acqStanStringOptional

    POS card transaction acquiring terminal trace number
  • acqRspCodeStringOptional

    POS card transaction acquiring response code
  • acqRspMessageStringOptional

    POS card transaction acquiring response message
  • acqBatchNumberStringOptional

    POS card transaction acquiring batch number
  • acqInvoiceNumberStringOptional

    POS card transaction acquiring invoice number
  • desensitizedCardNoStringOptional

    POS card transaction desensitized card number (first 6 and last 4 digits)
  • issuerBankNameStringOptional

    POS card transaction issuing bank name
  • cardHolderNameStringOptional

    POS card transaction cardholder name
• requestIdString(64)Required

  Unique request ID
• merchantTransactionIdString(64)Required

  Merchant transaction ID
• transactionIdString(64)Required

  PingPong transaction ID
• amountString(12)Required

  Transaction amount, precision depends on currency, see Transaction Currencies
• currencyString(3)Required

  Transaction currency, ISO 4217 three-letter currency code, see Transaction Currencies
• transactionTimeString(13)Required

  Transaction initiation time, timestamp (milliseconds)
• statusString(32)Required

  Transaction status:

  • PROCESSING - Processing
  • SUCCESS - Success
  • FAILED - Failed
• transactionEndingTimeString(13)Optional

  Transaction final state time, timestamp (milliseconds)
• remarkString(255)Optional

  Merchant extended fields, can be used to specify certain parameters, will be returned as is in the response

响应报文示例

{
  "accId": "PPX_ACC_202312001",
  "clientId": "PPX_MCH_20230001",
  "signType": "SHA256",
  "sign": "9F86D081884C7D659A2FEAA0C55AD015A3BF4F1B2B0B822CD15D6C15B0F00A08",
  "version": "1.0",
  "event": "PAY_QUERY_RESULT",
  "code": "0",
  "description": "查询受理成功",
  "requestTime": "1683532501000",
  "bizContent": {
    "requestId": "REQ_202312120001",
    "merchantTransactionId": "MCH_ORDER_20231212001",
    "transactionId": "PPX_TXN_202312120001",
    "amount": "100.00",
    "currency": "USD",
    "transactionTime": "1683530496000",
    "status": "SUCCESS",
    "transactionEndingTime": "1683530496900",
    "remark": "测试订单",
    "cardTransinfo": {
      "acqBankName": "Bank of America",
      "acqTermnialId": "TERM001",
      "acqMerchantId": "MCHNT001",
      "acqRRN": "RRN001",
      "acqStan": "STAN001",
      "acqRspCode": "00",
      "acqRspMessage": "Approved",
      "acqBatchNumber": "BATCH001",
      "acqInvoiceNumber": "INV001",
      "desensitizedCardNo": "123456******1234",
      "issuerBankName": "Bank of America",
      "cardHolderName": "John Doe"
    }
  }
}

Previous pagePayment API

Next pageQuery API