票据详情
POST
Request Body Parameters
application/json公共请求参数
bizContent
requestIdString(64)必填唯一请求号,全局唯一。invoiceIdString(64)必填票据 ID。
请求报文示例
{
"clientId": "20250101123456",
"accId": "ACC001",
"signType": "MD5",
"sign": "SIGN_VALUE",
"version": "4.0",
"bizContent": {
"requestId": "req_20260507_0011",
"invoiceId": "INV-260507100000000001"
}
}Responses Body Parameters
application/json公共返回参数
bizContent
subscriptionDetailObject可选订阅信息对象,非订阅场景不返回。subscriptionIdString(64)可选PingPong 订阅号。partnerSubscriptionIdString(64)可选商户侧订阅号。startAtString(10)可选账单所属周期起期,10 位秒级时间戳字符串。endAtString(10)可选账单所属周期止期,10 位秒级时间戳字符串。
customerObject可选买家对象,结构同买家接口响应主体。customerIdString(64)必填PingPong 买家 ID。partnerCustomerIdString(64)必填商户侧买家标识,用户在商户网站的会员 ID,同店铺内唯一。firstNameString(64)可选名。lastNameString(64)可选姓。companyNameString(128)可选公司名。emailString(128)可选邮箱。phoneString(20)可选电话。addressObject可选地址对象,结构同请求 address。countryString(2)可选国家二字码,ISO 3166 标准。stateString(128)可选州/省。cityString(50)可选城市。postalCodeString(16)可选邮编。line1String(256)可选地址行 1。line2String(256)可选地址行 2。
languageString(12)可选偏好语言地区。metadataString(512)可选商户自定义串。createdAtString(10)必填创建时间,10 位秒级时间戳字符串。updatedAtString(10)必填更新时间,10 位秒级时间戳字符串。
merchantObject可选开具方对象。legalNameString(128)可选商户法定名称。addressObject可选商户地址对象。businessAddressEnString(256)可选商户英文营业地址。postCodeString(16)可选邮编。countryString(64)可选国家。沙箱实测返回国家全名(如China)。
websiteString(255)可选商户网站。
paymentObject可选支付信息对象。statusString(32)可选支付状态。transactionIdString(64)可选PingPong 交易号。merchantTransactionIdString(64)可选商户交易号。methodTypeString(32)可选支付方式:卡支付返回卡品牌(如VISA),其他方式为全大写 APM 名称(如PAYNOW)。transactionTimeString(32)可选支付完成时间,ISO 8601 UTC。
downloadObject可选文件下载对象(当前版本详情响应可能不返回,建议直接通过票据下载接口获取下载链接)。urlString(512)可选下载链接,30 天有效。expiresAtString(10)可选链接过期时间,10 位秒级时间戳字符串。versionInteger可选文件对应票据版本。formatString(16)可选文件格式,当前为PDF。
requestIdString(64)必填唯一请求号,回显请求。invoiceIdString(64)必填票据 ID。invoiceNumberString(64)按条件选票据单据号,定稿后分配。versionInteger必填票据版本号,每次重渲染递增。statusString(32)必填票据状态:DRAFT:草稿,创建后未定稿,可更新或作废。FINALIZED:已定稿,单据号已分配,可下载。VOID:已作废。
PAYMENT_PENDING(扣款处理中)/PAID/PARTIALLY_REFUNDED(退款挂在首期票据上)/FULLY_REFUNDED。createdAtString(10)必填创建时间,10 位秒级时间戳字符串。finalizedAtString(10)可选定稿时间,10 位秒级时间戳字符串。paidAtString(10)可选支付完成时间,10 位秒级时间戳字符串。currencyString(3)必填币种,ISO 4217。subtotalString(12)必填小计金额,十进制字符串。totalString(12)必填总金额,十进制字符串。amountPaidString(12)可选已支付金额,十进制字符串。沙箱实测(2026-10-19):票据未支付完成(PAYMENT_PENDING)时不返回该字段。
响应报文示例
{
"clientId": "20250101123456",
"accId": "ACC001",
"signType": "MD5",
"sign": "SIGN_VALUE",
"code": "000000",
"description": "SUCCESS",
"bizContent": {
"requestId": "req_20260507_0011",
"invoiceId": "INV-260507100000000001",
"invoiceNumber": "INV-2605070001",
"version": 1,
"status": "FINALIZED",
"createdAt": "2026-05-07T00:00:00Z",
"finalizedAt": "2026-05-07T00:01:00Z",
"paidAt": "2026-05-07T00:02:00Z",
"currency": "USD",
"subtotal": "10.00",
"total": "10.00",
"amountPaid": "10.00",
"subscriptionDetail": {
"subscriptionId": "SUB-2605070001",
"partnerSubscriptionId": "sub_20260507_0002",
"startAt": "2026-05-07T00:00:00Z",
"endAt": "2026-06-07T00:00:00Z"
},
"customer": {
"customerId": "CUS-260507100000000001",
"partnerCustomerId": "USER_001",
"firstName": "James",
"lastName": "LeBron",
"email": "james@example.com"
},
"merchant": {
"legalName": "Example Pte. Ltd.",
"address": {
"businessAddressEn": "10 Marina Boulevard, Singapore",
"postCode": "018983",
"country": "SG"
},
"website": "https://merchant.example.com"
},
"payment": {
"status": "SUCCESS",
"transactionId": "260507100000000001",
"merchantTransactionId": "M202605070001",
"methodType": "CARD",
"transactionTime": "2026-05-07T00:02:00Z"
},
"download": {
"url": "https://example.com/invoice/INV-2605070001.pdf",
"expiresAt": "2026-06-06T00:00:00Z",
"version": 1,
"format": "PDF"
}
}
}