Alipay+Alipay+

Settlement Report

Overview

Settlement Report is sent from Alipay+ to Mobile Payment Partners (MPPs) for settlement purpose. This report is generated in a file format, according to the period agreed in the contract. The MPP needs to pay Alipay+ the amount stated in the Settlement Report from the clearing bank 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+ assigns to the Mobile Payment Partner. The field identifies the receiver of the file.
  • settlementCurrency: the currency that is used in 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 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 Settlement Report consists of two parts:

  • Summary section, which displays the settlement information.
  • Detail section, which lists the clearing cycles related to the 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 settlement amount 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.

Structure

Summary section

No.

Field

Description

1

settleDate

Required String

Settlement date (T+1 by default). The value is in the UTC+8 time zone.

2

valueDate

Required String

The date before which the Mobile Payment Partner needs to pay Alipay+ the amount stated in the Settlement Report from the clearing bank.

3

fundDirection

Required String

Fund direction. Valid values are:

  • CREDIT: specifies the fund direction that is from Alipay+ to the Mobile Payment Partner.
  • DEBIT: specifies the fund direction that is from the Mobile Payment Partner 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. 

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

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 Settlement Report file.

4

fundDirection

Required String

Fund direction. Valid values are:

  • CREDIT: specifies the fund direction that is from Alipay+ to the Mobile Payment Partner.
  • DEBIT: specifies the fund direction that is from the Mobile Payment Partner to Alipay+.

5

settlementCurrency

Required String (3)

The currency of the net settlement amount that is specified by 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. 

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. The MPP needs to pay Alipay+ 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 Alipay+ 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 MPP on the clearing date of 2018.12.25.
copy
settleDate,valueDate,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
20181226,20181226,DEBIT,USD,775,KRW,9300,
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
201812261102104****,20181225,2,DEBIT,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
settleDate,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. The MPP needs to pay Alipay+ 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 Alipay+ 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 that leads to a settlement fund of 7.75 USD for Alipay+ on the clearing date of 2018.12.25.
  • No transaction occurred on the clearing date of 2018.12.24.
copy
settleDate,valueDate,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
20181226,20181226,DEBIT,USD,775,KRW,9300,
clearingBatchId,clearingDate,totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
201812261102104****,20181225,2,DEBIT,USD,775,KRW,9300,
201812251102104****,20181224,0,DEBIT,USD,0,KRW,,