POST

📍如何选择站点？请参阅 API 端点地址

OpenAPI 总览

Request Body Parameters

application/json

公共请求参数

bizContent

• requestIdString(64)必填

  唯一请求号，全局唯一。
• receiptIdString(64)必填

  凭证 ID。

请求报文示例

{
  "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

公共返回参数

bizContent

• subscriptionDetailObject可选

  订阅信息对象，结构同票据详情，非订阅场景不返回。

  • subscriptionIdString(64)可选

    PingPong 订阅号。
  • partnerSubscriptionIdString(64)可选

    商户侧订阅号。
  • startAtString(10)可选

    账单所属周期起期，10 位秒级时间戳字符串。
  • endAtString(10)可选

    账单所属周期止期，10 位秒级时间戳字符串。
• refundRecordsArray必填

  退款记录列表（数组），无退款时为空数组。

  • amountString(12)可选

    退款金额，十进制字符串。
  • currencyString(3)可选

    退款币种。
  • transactionIdString(64)可选

    退款交易号。
  • merchantTransactionIdString(64)可选

    商户退款交易号。
  • refundedAtString(10)可选

    退款完成时间，10 位秒级时间戳字符串。
• downloadObject可选

  文件下载对象，结构同票据详情 download。当前版本详情响应可能不返回，建议直接通过凭证下载接口获取下载链接。

  • urlString(512)可选

    下载链接，30 天有效。
  • expiresAtString(10)可选

    链接过期时间，10 位秒级时间戳字符串。
  • versionInteger可选

    文件对应票据版本。
  • formatString(16)可选

    文件格式，当前为 PDF。
• requestIdString(64)必填

  唯一请求号，回显请求。
• receiptIdString(64)必填

  凭证 ID。
• receiptNumberString(64)必填

  凭证单据号。
• invoiceIdString(64)必填

  关联票据 ID。
• invoiceNumberString(64)必填

  关联票据单据号。
• statusString(32)必填

  凭证状态：

  • PAID：已支付。
  • PARTIALLY_REFUNDED：部分退款。
  • FULLY_REFUNDED：全额退款。
• paidAtString(10)可选

  支付完成时间，10 位秒级时间戳字符串。
• amountPaidString(12)必填

  已支付金额，十进制字符串。
• currencyString(3)必填

  币种，ISO 4217。
• transactionIdString(64)必填

  PingPong 交易号。
• merchantTransactionIdString(64)必填

  商户交易号。
• methodTypeString(32)可选

  支付方式：卡支付返回卡品牌（如 VISA），其他方式为全大写 APM 名称（如 PAYNOW）。

响应报文示例

{
  "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"
    }
  }
}

上一页票据下载

下一页凭证下载