Alipay+Alipay+

Settlement Report

Overview

Settlement reports are provided by Alipay+ to the Acquiring Partner (ACQP) for settlement purpose. This report is generated in the file format, according to the period agreed in the contract. The settlement report file is uploaded to a specific directory in SFTP. The ACQP can download and use it for reconciliation.

Alipay+ needs to pay the ACQP 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 text file in the UTF-8 encoding. By default, this file is saved in the directory /v1/settlements/settlement/<participantId>/<date>, and the default file name is settlement_<participantId>_<settlementCurrency>_<settlementBatchId>_<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 one that is stated in the Fee Report.
  • settlementBatchId: the settlement batch ID.
  • 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 settlement report consists of two parts:

  • Summary section, which displays the settlement information.
  • Details 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. 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. 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.

Structure

Summary section

No.

Field

Description

1

settlementDate

Required String

Settlement date. The value is in the UTC+8 time zone.

2

valueDate

Required String

The date before which Alipay+ needs to pay the ACQP 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

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+

4

settlementCurrency

Required String (3)

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

5

netSettlementAmountValue

Required String (16)

The net settlement amount. The value is provided in the smallest unit of the corresponding currency.

6

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.

7

netTransactionAmountValue

Optional String (16)

Net transaction amount. 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.

8

extendInfo

Optional String (2048)

Extended information

Details 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. 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. 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 settlement day is a business day, and the settlement amount is above the settlement amount threshold. Alipay+ needs to pay the ACQP the settlement amount before December 26, 2018.

See the following section for details:

  • Summary section: A settlement fund of 7.75 USD in total is due for the ACQP on the settlement date of 2018.12.26, as a result of transactions netting 93 KRW in total.
  • Detail section: 2 clearing entries that netting 93 KRW in total lead to a settlement fund of 7.75 USD for the ACQP on the clearing date of 2018.12.26.
copy
settlementDate,valueDate,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
20181226,20181226,CREDIT,USD,775,KRW,9300,
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
201812261102104****,20181226,2,CREDIT,USD,775,KRW,9300,

Use case 2

The following sample assumes that the settlement day is a business day, but the settlement amount is below the settlement amount threshold.

copy
settlementDate,valueDate,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
20181226,20181226,CREDIT,USD,0,,,
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo

Use case 3

The following sample assumes that the settlement day is a business day, and the settlement amount is above the settlement amount threshold, including multiple clearing cycles. Alipay+ needs to pay the ACQP the settlement amount before December 26, 2018.

See the following section for details:

  • Summary section: A settlement fund of 7.75 USD in total is due for the ACQP on the settlement date of 2018.12.26, as a result of transactions netting 93 KRW in total.
  • Detail section:
    • 2 clearing entries that netting 93 KRW in total lead to a settlement fund of 7.75 USD for the ACQP on the clearing date of 2018.12.26.
    • No transaction occurred on the clearing date of 2018.12.25.
copy
settlementDate,valueDate,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
20181226,20181226,CREDIT,USD,775,KRW,9300,
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
201812261102104****,20181226,2,CREDIT,USD,775,KRW,9300,
201812251102104****,20181225,0,CREDIT,USD,0,KRW,,

Use case 4

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

See the following section for details:

  • Summary section: A settlement fund of 2000 USD in total is due for the ACQP on the settlement date of 1992.09.03.
  • Detail section:
    • 3 clearing entries that using different currencies lead to a settlement fund of 1000 USD for the ACQP on the clearing date of 1992.09.02.
    • 2 clearing entries that using different currencies lead to a settlement fund of 1000 USD for the ACQP on the clearing date of 1992.09.01.
copy
settlementDate,valueDate,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
19920903,19920903,CREDIT,USD,200000,,,
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
202105121103107870,19920902,3,CREDIT,USD,100000,,,
202105121103107869,19920901,2,CREDIT,USD,100000,,,