Transaction Summary Report
Overview
Transaction Summary Report provides summary information, such as the total number of transactions in a period of time and the amount for the settlement, for clearing data from Alipay+ to Mobile Payment Partners (MPPs). 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.
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+ assigns to the Mobile Payment Partner. The field identifies the receiver of the file.
- clearingBatchId: clearing cycle index, used to indicate a unqiue clearing cycle.
- settlementCurrency: the currency that is used in settlement, as agreed in the contract.
- participantAgreementId: the unique ID that is assigned by Alipay+ to identify a settlement agreement between Alipay+ and the Mobile Payment Partner. The ID represents the fund flow when Mobile Payment Partner performs settlement to Alipay+.
- seq: the sequence number that is in the range
000-999. The field is used when multiple files exist in the clearing cycle. The MPP and Alipay+ can determine the time when all records are available in SLA.
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. |
2 | clearingDate | Required String The date when the transaction occurs. The value is in the UTC+8 time zone. |
3 | totalCount | Required String Total number of items in the clearing summary report file. |
4 | fundDirection | Required String Fund direction. Valid values are:
|
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. 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 MPP 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 Transaction Summary Report, together with a Transaction Detail Report and a Fee Report, to the MPP on December 26, 2018.
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
201812261102104****,20181226,2,DEBIT,USD,775,KRW,9300,
Use case 2
The following sample assumes that the MPP 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 MPP on December 26, 2018.
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
201812261102104****,20181226,0,DEBIT,USD,0,,,