POST

📍How to choose a site? See API Endpoint Guide

Request Body Parameters

application/json

Common Request Parameters

bizContent

• customerObjectConditional

  User information, required for refunds using special payment methods. For more details, see the Special Payment Method Refund Instructions.

  • nameString(16)Conditional

    Name under the user's bank account
• subOrderListArrayOptional

  Sub-order information list

  • subMerchantIdString(64)Required

    Sub-merchant number on the merchant platform
  • subMerchantTransactionIdString(64)Required

    Sub-merchant order number, a unique identifier for the sub-order
  • amountString(12)Required

    Sub-order amount
  • currencyString(3)Required

    Currency of the sub-order amount, must be consistent with the original transaction currency
• merchantTransactionIdString(64)Required

  Merchant website order number
• merchantRefundIdString(64)Required

  The merchant's refund transaction serial number, globally unique.
• amountString(14)Required

  Refund transaction amount, in the smallest unit. For currency details, see the attached Transaction Currencies table.
• currencyString(3)Required

  Transaction currency, ISO 4217 three-letter code. For supported currencies, refer to the Transaction Currencies table.
• accountNumberString（32）Conditional

  Refund account number, required for specific payment methods. For more details, see the Special Payment Method Refund Instructions.
• channelCodeString(32)Conditional

  Bank code, required for refunds using special payment methods. For more information, see the Special Payment Method Refund Instructions.
• phoneString(20)Conditional

  Phone number, required for refunds using special payment methods. For further details, see the Special Payment Method Refund Instructions.
• identificationIdString(32)Conditional

  ID number, required for refunds using special payment methods. For additional information, see the Special Payment Method Refund Instructions.
• emailString(32)Conditional

  Email, required for refunds using special payment methods. For more details, see the Special Payment Method Refund Instructions.
• notificationUrlString(255)Optional

  A custom address set by the merchant for notifying the transaction result. Once this parameter is filled, PingPongCheckout will asynchronously push the transaction result to this address via POST.
  URL recommendation: use a complete URL with a publicly reachable domain name. Standard web ports are recommended (HTTPS defaults to 443 and HTTP defaults to 80). Ensure the URL can reliably receive PingPongCheckout asynchronous notifications.
• remarkString(32)Conditional

  Merchant extended field

Request Body Example

{
  "accId": "2023042011040310224447",
  "bizContent": {
    "amount": 100,
    "currency": "USD",
    "merchantTransactionId": "PMT-2S7RR3K4LQ1715047351210",
    "notificationUrl": "https://test-acquirerpay.pingpongx.com/qa/result.html",
    "merchantRefundId": "PMT-4DNTI3AWXR1715049316146"
  },
  "clientId": "2023042011040310224",
  "sign": "7F271F64F5ADDF225D76A8F3EADFD5E4F6E71716635D2F18DD51DB6D8CD50E78",
  "signType": "SHA256",
  "version": "1.0"
}

Responses Body Parameters

application/json

Common Response Parameters

bizContent

• transactionIdString(64)Required

  PingPong original transaction serial number
• merchantTransactionIdString(64)Required

  Merchant website's original transaction serial number
• merchantRefundIdString(64)Required

  Merchant website's refund transaction serial number
• refundIdString(64)Required

  PingPong refund transaction serial number
• currencyString(3)Required

  Transaction currency
• amountString(14)Required

  Transaction amount
• refundTimeString(32)Required

  Refund initiation time, timestamp
• refundEndingTimeString(32)Optional

  Refund final state arrival time, timestamp
• statusString(32)Required

  1. SUCCESS - Success
  2. FAILED - Failure
  3. PROCESSING - In progress
• remarkString(32)Conditional

  Merchant extended field

Request Body Example

{
  "accId": "2023042011040310224447",
  "bizContent": {
    "amount": "100.000000",
    "refundTime": "1715049319280",
    "transactionId": "2024050750046460",
    "merchantTransactionId": "PMT-2S7RR3K4LQ1715047351210",
    "currency": "USD",
    "merchantRefundId": "PMT-4DNTI3AWXR1715049316146",
    "refundId": "2024050750046461",
    "status": "SUCCESS"
  },
  "clientId": "2023042011040310224",
  "code": "000000",
  "description": "Transaction succeeded",
  "sign": "9475FF30D4DF1A3FD9696EBFBAC72729A7E6140D4E39490097C7F06BDD69020C",
  "signType": "SHA256"
}

Previous pagePre-Authorization Void

Next pageBatch Add Sub-Merchant API