Transaction Summary Report
Overview
Transaction Summary Reports that are provided by Alipay+ to the Acquiring Service Provider (ACQP) include the summary information for clearing data, for example, the total number of transactions in a clearing cycle, the amount for the settlement, and so on. If there is only one clearing cycle in the settlement cycle, the total settlement amount in the Settlement Report and the one in the Transaction Summary Report are the same.
For every clearing cycle, a Transaction Summary Report is created with other reports in the same clearing cycle, such as the Transaction Detail Report and the Fee Report. The reports are uploaded to a specific directory on the SFTP server. The ACQP can download and use them for reconciliation.
File location and naming convention
The Transaction Summary Report is a UTF-8 encoded text file. 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. This field identifies the receiver of the file.
- 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. | Parameter | 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 The fund direction. Valid values are:
|
5 | settlementCurrency | Required String (3) The currency of the net settlement amount. The value is specified by using the 3-character ISO 4217 currency code. |
6 | netSettlementAmountValue | Required Integer The net settlement amount, which is the summary amount of all the records in the clearing cycle. The value is provided in the smallest unit of the corresponding currency. For example, if the currency is USD and the amount is $1.00, the value of this parameter is 100; if the currency is JPY and the amount is ￥1, the value of this parameter is 1. Value range: 0 - unlimited. |
7 | transactionCurrency | Optional String (3) The currency of the net transaction amount. The value is specified by using the 3-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 Integer The net transaction amount, which is the summary amount of all the records in the clearing cycle. The value is provided in the smallest unit of the corresponding currency. For example, if the currency is USD and the amount is $1.00, the value of this parameter is 100; if the currency is JPY and the amount is ￥1, the value of this parameter is 1. Note: This field is empty when no transaction occurs in the clearing cycle or multiple transaction currencies are involved in the clearing cycle. Value range: 0 - unlimited. |
9 | extendInfo | Optional String (2048) The extended information. |
Samples
This section contains sample reports for different scenarios.
Case 1
The following sample is the summary report based on the sample Payment only detail report. A settlement fund of 19.6 EUR is to be paid to the ACQP due to payments that net 20 EUR in total on 2022-04-19. The transactions are made and settled in EUR.
📎summary_A1234567890_EUR_202204190000200000_20210001_000.csv
Case 2
The following sample is the summary report based on the sample Payment & refund detail report. A settlement fund of 79.57 EUR is to be paid to the ACQP due to transactions that net 82 EUR in total on 2022-04-28. The transactions are made and settled in EUR.
📎summary_A1234567890_EUR_202204280000200000_20210000_000.csv
Case 3
The following sample is the summary report based on the sample Payment & refund in multiple currencies detail report. A settlement fund of 0.5 EUR is to be paid to the ACQP due to transactions on 2022-01-10. The transactions are made in different currencies so the net transaction amount and the transaction currency are empty. The settlement is made in EUR.
📎summary_A1234567890_EUR_202201101107957472_202109171107900901003800022697_000.csv