Settlement Report
Overview
Settlement Reports are provided by Alipay+ to the Mobile Payment Providers (MPPs) for settlement purposes. This report is generated according to the period agreed in the contract. The Settlement Report is uploaded to a specific directory on the SFTP server. The MPP can download and use it for reconciliation.
The MPP needs to pay Alipay+ the amount stated in the Settlement Report from the clearing bank by fund payment before the date specified by valueDate.
File location and naming convention
The Settlement Report file is a UTF-8 encoded text file.
In the production environment, the file is saved by default in the directory /v1/settlements/settlement/<participantId>/<date>. And in the sandbox environment, the file is saved in the directory /sandbox/settlements/settlement/<participantId>/<date>.
The default file name is settlement_<participantId>_<settlementCurrency>_<settlementBatchId>_<participantAgreementId>_<seq>.csv. For the detailed information of each field in the file name, refer to the following table:
Field Name | Details |
participantId | The unique ID that Alipay+ issues to the MPP. 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 the settlement, as agreed in the contract. |
settlementBatchId | The settlement batch ID. |
participantAgreementId | The unique ID that is assigned by Alipay+ to identify a settlement agreement between Alipay+ and the MPP. The value of the participantAgreementId parameter is determined by the value of the participantId parameter and the settlement currency used by the MPP. The ID represents the fund flow when MPP performs settlement to Alipay+. |
| seq | The sequence number used as a file index. The field is used when multiple files exist in the settlement cycle. The file index is ordered in the range of |
Report structure
The Settlement Report consists of two parts:
- Summary section, which displays the settlement information.
- Detail section, which lists the clearing cycles that are related to this settlement.
Each Settlement Report only contains one set of settlement information, but the settlement information might include information from multiple clearing cycles. The Settlement Report is only generated on the settlement date. In addition, if the settlement date is a holiday, no report will be generated, and neither will the directory.
When no amount is to be settled, or the amount to be settled is less than the settlement amount threshold as agreed in the contract, a Settlement Report is generated with an amount of 0. The transaction amount and currency are empty.
Structure
Summary section
No. | Parameter | Description |
1 | settleDate | Required String The settlement date (T+1 by default). The value is in the UTC+8 time zone. |
2 | valueDate | Required String The date before which the MPP needs to pay Alipay+ the amount that is stated in the Settlement Report from the clearing bank. The value is in the UTC+8 time zone. |
3 | fundDirection | Required String The fund direction. Valid values are:
|
4 | settlementCurrency | Required String (3) The currency of the net settlement amount. The value is specified by using the 3-character ISO 4217 currency code. |
5 | netSettlementAmountValue | Required Integer The net settlement amount. 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. |
6 | 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 settlement 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 settlement cycle or multiple transaction currencies are involved in the settlement cycle. |
7 | netTransactionAmountValue | Optional Integer The net transaction amount. 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. Note: This field is empty when no transaction occurs in the settlement cycle or multiple transaction currencies are involved in the settlement cycle. |
8 | extendInfo | Optional String (2048) The extended information. |
Details 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 Clearing Transaction Report and the value of the totalCount parameter in the Clearing 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. 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. 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. 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) The extended information. |
Samples
This section contains sample reports for different scenarios.
One clearing cycle: case 1 (Payment only)
The following sample is the settlement report based on the sample Payment only Transaction Detail Report. On settlement day 2022-04-21, there is one clearing cycle (batch ID 202204190000200000), where a settlement amount of 19.6 EUR is to be paid to Alipay+, as a result of transactions that net 19.6 EUR in total on 2022-04-19. The transactions are made and settled in EUR.
You can view the sample in the following window or download the sample file:
📎settlement_A1234567890_EUR_202204190000200000_20210001_000.csv
One clearing cycle: case 2 (Payment & refund)
The following sample is the settlement report based on the sample Payment & refund Transaction Detail Report. On settlement day 2022-05-02, there is one clearing cycle (batch ID 202204280000200000), where a settlement amount of 81.15 EUR is to be paid to Alipay+, as a result of transactions that net 81.15 EUR in total on 2022-04-28. The transactions are made and settled in EUR.
You can view the sample in the following window or download the sample file:
📎settlement_A1234567890_EUR_202204280000200000_20210000_000.csv
One clearing cycle: case 3 (Payment & refund in multiple currencies)
The following sample is the settlement report based on the sample Payment & refund in multiple currencies Transaction Detail Report. On settlement day 2022-01-12, there is one clearing cycle (batch ID 202201111117957472), where a settlement amount of 0.5 EUR is to be paid to Alipay+, as a result of transactions that net 0.5 EUR in total on 2022-01-10.
You can view the sample in the following window or download the sample file:
📎settlement_A1234567890_EUR_202201111117957472_202109171107900901003800022697_000.csv
Multiple clearing cycles
The following sample assumes that on settlement day 2022-01-12 there are 18 clearing cycles in the settlement cycle and the total settlement amount is 0.19 EUR. The settlement is made in EUR.
You can view the sample in the following window or download the sample file: