POST

📍How to choose a site? See API Endpoint Guide

OpenAPI Viewer

Request Body Parameters

application/json

Common Request Parameters

bizContent

• requestIdString(64)Required

  Unique request ID, globally unique.
• receiptIdString(64)Required

  Receipt ID.

Request Body Example

{
  "clientId": "20250101123456",
  "accId": "ACC001",
  "signType": "MD5",
  "sign": "SIGN_VALUE",
  "version": "4.0",
  "bizContent": {
    "requestId": "req_20260507_0021",
    "receiptId": "RCT-260507100000000001"
  }
}

Responses Body Parameters

application/json

Common Response Parameters

bizContent

• subscriptionDetailObjectOptional

  Subscription information object, same structure as in Invoice Details. Not returned for non-subscription scenarios.

  • subscriptionIdString(64)Optional

    PingPong subscription ID.
  • partnerSubscriptionIdString(64)Optional

    Merchant-side subscription ID.
  • startAtString(10)Optional

    Start of the billing period covered by this invoice, as a 10-digit second-level timestamp string.
  • endAtString(10)Optional

    End of the billing period covered by this invoice, as a 10-digit second-level timestamp string.
• refundRecordsArrayRequired

  Refund record list (array). Empty when no refund exists.

  • amountString(12)Optional

    Refund amount as a decimal string.
  • currencyString(3)Optional

    Refund currency.
  • transactionIdString(64)Optional

    Refund transaction ID.
  • merchantTransactionIdString(64)Optional

    Merchant refund transaction ID.
  • refundedAtString(10)Optional

    Refund completion time as a 10-digit second-level timestamp string.
• downloadObjectOptional

  File download object, same structure as download in Invoice Details. Not returned by the details response in the current version; use the Receipt Download API to obtain the download URL.

  • urlString(512)Optional

    Download URL, valid for 30 days.
  • expiresAtString(10)Optional

    URL expiration time as a 10-digit second-level timestamp string.
  • versionIntegerOptional

    Invoice version that the file corresponds to.
  • formatString(16)Optional

    File format, currently PDF.
• requestIdString(64)Required

  Unique request ID, echoed from the request.
• receiptIdString(64)Required

  Receipt ID.
• receiptNumberString(64)Required

  Receipt number.
• invoiceIdString(64)Required

  Associated invoice ID.
• invoiceNumberString(64)Required

  Associated invoice number.
• statusString(32)Required

  Receipt status:

  • PAID: paid.
  • PARTIALLY_REFUNDED: partially refunded.
  • FULLY_REFUNDED: fully refunded.
• paidAtString(10)Optional

  Payment completion time as a 10-digit second-level timestamp string.
• amountPaidString(12)Required

  Amount paid, as a decimal string.
• currencyString(3)Required

  Currency, ISO 4217.
• transactionIdString(64)Required

  PingPong transaction ID.
• merchantTransactionIdString(64)Required

  Merchant transaction ID.
• methodTypeString(32)Optional

  Payment method: the card brand for card payments (e.g. VISA), or an upper-case APM name (such as PAYNOW).

Request Body Example

{
  "clientId": "20250101123456",
  "accId": "ACC001",
  "signType": "MD5",
  "sign": "SIGN_VALUE",
  "code": "000000",
  "description": "SUCCESS",
  "bizContent": {
    "requestId": "req_20260507_0021",
    "receiptId": "RCT-260507100000000001",
    "receiptNumber": "RCT-2605070001",
    "invoiceId": "INV-260507100000000001",
    "invoiceNumber": "INV-2605070001",
    "subscriptionDetail": {
      "subscriptionId": "SUB-2605070001",
      "partnerSubscriptionId": "sub_20260507_0002",
      "startAt": "2026-05-07T00:00:00Z",
      "endAt": "2026-06-07T00:00:00Z"
    },
    "status": "PAID",
    "paidAt": "2026-05-07T00:02:00Z",
    "amountPaid": "10.00",
    "currency": "USD",
    "transactionId": "260507100000000001",
    "merchantTransactionId": "M202605070001",
    "methodType": "CARD",
    "refundRecords": [],
    "download": {
      "url": "https://example.com/receipt/RCT-2605070001.pdf",
      "expiresAt": "2026-06-06T00:00:00Z",
      "version": 1,
      "format": "PDF"
    }
  }
}

Previous pageInvoice Download

Next pageReceipt Download