Alipay+Alipay+

Transaction Summary Report

Overview

Transaction Summary Reports that are provided by Alipay+ to the Acquiring Partner (ACQP) include the summary information for clearing data, for example, the total number of transactions in a clearing cycle, the amount for settlement, and so on. For every clearing cycle, a Transaction Summary Report is created with other reports in the same clearing cycle, such as Transaction Detail Report and fee report.

File location and naming convention

The Transaction Summary Report is a text file in the UTF-8 encoding. By default, the file is saved in the directory /v1/settlements/clearing/<participantId>/<date>,and the default file name is summary_<participantId>_<settlementCurrency>_<clearingBatchId>_<participantAgreementId>_<seq>.csv, where:

  • participantId: the unique ID that Alipay+ issues to the ACQP.
  • date: the date when the report is generated, not the date of the transactions. For example, a report with a date of 20220319 is generated on 20220319.
  • settlementCurrency: the currency that is used in settlement, as agreed in the contract. This is the same as the settlement currency stated in this Transaction Summary Report file.
  • clearingBatchId: clearing cycle index, used to indicate a unique clearing cycle. A clearing cycle is from 00:00 to 23:59:59, UTC+8.
  • participantAgreementId: is the unique ID that is assigned by Alipay+ to identify a settlement agreement between Alipay+ and the ACQP. The value of the participantAgreementId parameter is determined by the value of the participantId parameter and the settlement currency used by the ACQP (and separately allocated for AlipayCN). The ID represents the fund flow when Alipay+ performs settlement to the ACQP.
  • seq: the sequence number used as a file index. The field is used when multiple files exist in the clearing cycle. The file index is ordered in the range of 000-999.

Report structure

The Transaction Summary Report consists of one part:

  • Detail section, which displays the summary information for the clearing data in the clearing cycle.

If no transaction exists in a clearing cycle, the transaction summary report is still generated with 0 total count, 0 total amount, and a default direction of D.

Structure

Summary section

N/A

Detail section

No.

Field

Description

1

clearingBatchId

Required String (32)

The unique ID that is assigned by Alipay+ to identify a clearing cycle. A clearing cycle is from 00:00 to 23:59:59, UTC+8.

2

clearingDate

Required String

The date when the transaction occurs. The value is in the UTC+8 time zone.

3

totalCount

Required String

The total count of transactions and fees in a clearing cycle. The value here is the sum of the value of the totalCount parameter in the Transaction Detail Report and the value of the totalCount parameter in the Fee Report.

4

fundDirection

Required String

Fund direction. Valid values are:

  • CREDIT: specifies the fund direction that is from Alipay+to the ACQP.
  • DEBIT: specifies the fund direction that is from the ACQP to Alipay+.

5

settlementCurrency

Required String (3)

The currency of the net settlement amount. The value is specified by using the three-character ISO 4217 currency code.

6

netSettlementAmountValue

Required String (16)

The net settlement amount, which calculates the summary amount of all the records. The value is provided in the smallest unit of the corresponding currency.

7

transactionCurrency

Optional String (3)

The currency of the net transaction amount. The value is specified by using the three-character ISO 4217 currency code. The currency here is the same as the currency of the transactions in the clearing cycle, which is the value of the paymentAmount.currency parameter in the pay API.

Note: This field is empty when no transaction occurs in the clearing cycle or multiple transaction currencies are involved in the clearing cycle.

8

netTransactionAmountValue

Optional String (16)

Net transaction amount, which calculates the summary amount of all the records. The value is provided in the smallest unit of the corresponding currency. 

Note: This field is empty when no transaction occurs in the clearing cycle or multiple transaction currencies are involved in the clearing cycle.

9

extendInfo

Optional String (2048)

Extended information

Sample

Use case 1

The following sample assumes that the ACQP with an ID of 102xxxxxxxxxxxx0001 gets a settlement fund of 7.75 USD in total, as a result of 2 transactions that net 93 KRW in total on December 25, 2018. Alipay+ provides a Transaction Summary Report, together with a Transaction Detail Report and a Fee Report, to the ACQP on December 26, 2018.

copy
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
201812261102104****,20181226,6,CREDIT,USD,775,KRW,9300,

Use case 2

The following sample assumes that the ACQP with an ID of 102xxxxxxxxxxxx0001 has no transactions on December 25, 2018. Alipay+ provides a Transaction Summary Report, together with a Transaction Detail Report and a fee report, to the ACQP on December 26, 2018.

copy
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
201812261102104****,20181226,0,CREDIT,USD,0,,,

Use case 3

When multiple transaction currencies are involved in the clearing cycle, the fields of transactionCurrency and netTransactionAmountValue are empty.

copy
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
202105121103107870,19920902,3,CREDIT,USD,100000,,,settlementDate^1992-09-03+08:00