交易账单文件

交易账单文件由 Alipay 向商家提供,该文件包含 T 日所有成功交易的明细,于 T+1 日生成。

文件路径和文件名

交易账单文件为 UTF-8 编码的 CSV 文件,您可以登录支付宝 SFTP 服务器,在指定目录下获取该文件。文件存储路径默认为 /v1/settlements/<customerId>/<transactionDate>/ 加上文件名。文件名是 transactionItems_<transactionDate>_<seq>.csv

文件名称中变量的含义如下所示:

  • customerId 支付宝为商家分配的唯一身份标识。
  • transactionDate:交易日期。
  • seq:文件序列号,固定为 000。

文件字段

交易账单文件包含两部分内容:交易详情和文件结束符。<END> 作为文件结束标志出现在文件的最后一行。交易详情由字段和其对应的值说明。下表展示了账单正文中字段的详细信息:

字段

说明

customerId

必需 String (64)

支付宝为商家分配的唯一身份标识。

referenceMerchantId

可选 String (64)

直接向买家提供服务或商品的商家唯一标识,由对应商家分配。

注意:该字段的值需要与其他交易类型的原先支付或授权请求中的referenceMerchantId 字段的值相同。

referenceStoreId

可选 String (64)

商家店铺的唯一标识,由对应商家分配。

transactionId

必需 String (64)

支付宝分配的交易唯一标识。该字段的值遵循以下规则:

  •  transactionType PAYMENTCANCELAUTHORIZATION 时,该字段的值与 paymentId 的值相同。
  •  transactionType CAPTURE 时,该字段的值与 captureId 的值相同。
  •  transactionType REFUND 时,该字段的值与 refundId 的值相同。

originalTransactionId

可选 String (64)

原始交易的标识符。

  •  transactionType PAYMENTCANCELAUTHORIZATIONVOID 时,该字段的值为空。
  •  transactionType REFUND 时,该字段的值与原先支付或授权请求的 paymentId 相同
  •  transactionType CAPTURE 时,该字段的值与原先支付或授权请求的 paymentId 相同

transactionRequestId

必需 String (64)

商家分配的交易请求唯一标识。该字段的值与付款的 paymentRequestId 的值相同,或与退款的 refundRequestId 的值相同。

referenceTransactionId

可选 String (64)

直接向买家提供服务或商品的商家分配的唯一标识,用于识别交易。该字段的值与付款的 referenceOrderId 的值相同

orderDescription

可选 String (256)

订单说明

paymentMethodType

必需 String (32)

付款方式类型。

对于代扣和收银台支付,可能的值为:

  • TRUEMONEY
  • ALIPAY_HK
  • TNG
  • ALIPAY_CN
  • GCASH
  • DANA
  • BKASH
  • EASYPAISA
  • KAKAOPAY
  • CONNECT_WALLET
  • RABBIT_LINE_PAY
  • BPI
  • BOOST
  • IDEAL
  • GIROPAY
  • SOFORT
  • PAYU
  • P24
  • BLIK
  • EPS
  • BANCONTACT

注意:该字段的值需要与其他交易类型的原先支付或授权请求中的paymentMethodType 字段的值相同

pspName

可选 String (64)

Alipay+ 移动支付合作伙伴的名称,例如 Gcash。

注意:该字段的值需要与其他交易类型的原先支付或授权请求中的 pspName 字段的值相同

transactionType

必需 String

交易类型,可能的值为:

  • PAYMENT
  • REFUND
  • CANCEL
  • AUTHORIZATION
  • CAPTURE
  • VOID

paymentTime

必需 String (64)

交易达到成功或失败终态的日期和时间,格式为 ISO 8601中定义的 YYYY-MM-DDTHH:MM:SS+hh:mm

productCode

必需 String

支付宝和商家合同中约定的支付产品类型。可能的值为:

  • AGREEMENT_PAYMENT:表示自动扣款。
  • IN_STORE_PAYMENT:表示店内支付。
  • CASHIER_PAYMENT:表示收银台付款。

注意:该字段的值需要与其他交易类型的原先支付或授权请求中的 productCode 字段的值相同

transactionAmountValue

必需 String (16)

货币主要单位的交易金额。

transactionCurrency

必需 String (3)

transactionAmountValue 对应的货币,为 ISO 4217 中定义的 3 个字母的货币代码 。

originalTransactionRequestId

可选 String (64)
交易类型为 REFUNDCANCELCAPTURE 时交易的原先支付请求 ID。该字段在其他情况下为空。

表 1. 交易账单文件字段及解释

文件样本

样本一

在 2018 年 12 月 25 日(交易日), ID 为 1022188000000000001 的商家产生了两笔交易,一笔付款,一笔退款。

  • 付款信息:
    • transactionId : 交易流水号 2018122519074101000000000112612,也是 paymentId 的值。
    • transactionAmountValue : 交易金额18000 (KRW)。
  • 退款信息:
    • transactionId:交易流水号 2018122519074102000000000041675,也是 refundId 的值。
    • transactionAmountValue:交易金额 9000 (KRW) 。
    • originalTransactionId: 原始交易流水号 2018122519074101000000000112612,与原先支付请求中的 paymentId 相同

在 2018 年 12 月 26 日,支付宝生成了一个 CSV 文件,文件名为 transactionItems_20181225_000.csv. 本例中商家 ID (customerId) 为1022188000000000001,故文件路径为 /v1/settlements/1022188000000000001/20181225/transactionItems_20181225_000.csv.

交易详情如下:

copy
customerId,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,orderDescription,paymentMethodType,pspName,transactionType,paymentTime,productCode,transactionAmountValue,transactionCurrency 1022188000000000001,,,2018122519074101000000000112612,,20190326L648423000404,,,KAKAOPAY,KaKaoPay,PAYMENT,2018-12-25T10:00:00+08:30,AGREEMENT_PAYMENT,18000,KRW, 1022188000000000001,,,2018122519074102000000000041675,2018122519074101000000000112612,20190326L648423000404,,,KAKAOPAY,KaKaoPay,REFUND,2018-12-25T10:00:00+08:30,AGREEMENT_PAYMENT,-9000,KRW <END>

样本二

2018 年 12 月 25 日商家无交易,但 2018 年 12 月 26 日,支付宝仍生成了一个 CSV 文件,内容仅包含字段名和文件结束符,文件名为 transactionItems_20181225_000.csv

交易详情如下:

copy
customerId,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,orderDescription,paymentMethodType,pspName,transactionType,paymentTime,productCode,transactionAmountValue,transactionCurrency <END>

注意您可配置是否在无交易情况下生成该文件,详情请联系支付宝技术支持团队。