Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

Settlement summary report

The settlement summary report includes information such as the total number of transactions and net settlement amount within a settlement period. The report is generated along with the settlement details report on the next day after receiving the bank receipt for the settlement. You can obtain this report through the SFTP server or Alipay Global Merchant Portal.

Report details

The settlement summary report consists of three parts: header information, transaction details, and the end-of-file <END> that appears in the last line of the report. The header information is represented by parameter names, and the settlement summary information is represented by the corresponding values of the parameters.

The following table shows the parameters in the settlement summary report and parameter descriptions:

Parameter

Description

settlementBatchId

MANDATORY String (64)

The unique ID that is assigned by the acquirer to identify a settlement period, which corresponds to the settlement batch number in the settlement summary parameter. If the acquirer does not assign settlementBatchId, Alipay will generate this ID.

customerId

MANDATORY String (64)

The unique ID that is assigned by the acquirer to identify a merchant.

acquirer

MANDATORY String (64)

The name of the acquirer that processes the transactions.

The acquirer here specifically means the acquirer that provides acquiring and funds settlement services for the merchant.

summaryType

OPTIONAL String (16)

The type of the settlement summary. Valid values are:

  • AUTHORIZATION: indicates a summary of authorized payments within a settlement batch.
  • PAYMENT: indicates a payment summary within a settlement batch.
  • CAPTURE: indicates a capture summary within a settlement batch.
  • REFUND: indicates a refund summary within a settlement batch.
  • CANCEL: indicates a cancellation summary within a settlement batch.
  • DISPUTE: indicates a dispute summary within a settlement batch.
  • VOID: indicates a summary of void authorizations within a settlement batch.
  • TOTAL: indicates a total settlement summary within a settlement batch.
  • REFUND_REVERSAL: indicates a reversed refund summary within a settlement batch. A reversed refund occurs when the payment method is unable to correctly process the refund. The funds are returned to your account.
  • SETTLEMENT_FEE: indicates the summary of the settlement fee charged by the acquirer. The fee details are represented by the settlementAmountValue and settlementCurrency parameters.
  • DISPUTE_REVERSAL: indicates a reversal of a successfully defended dispute.
  • COLLATERAL_WITHHOLDING: indicates the withholding of collateral funds.
  • RESERVE_WITHHOLDING: indicates the withholding of reserve funds.
  • RESERVE_RELEASE: indicates the release of reserve funds.
  • COLLATERAL_RELEASE: indicates the release of collateral funds.

settlementTime

MANDATORY String (64)

The date and time when the settlement file is generated, in the format of YYYY-MM-DDTHH:MM:SS+hh:mm as defined in ISO 8601.

count

MANDATORY Integer

Indicates the total number of transaction records.

settlementAmountValue

MANDATORY String (16)

The net settlement amount in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

When the acquirer is Hundsun and the value of summaryType is TOTAL, the value of this parameter is accurate. When the acquirer is Hundsun and the value of summaryType is other than TOTAL, the value of this parameter may be skewed. For more information about the error correction information, see Acquirer Hundsun.

settlementCurrency

MANDATORY String (3)

The currency of settlementAmountValue, specified by a 3-letter currency code as defined in ISO 4217.

feeAmountValue

MANDATORY String (16)

The amount of the processing fee that is charged by the acquirer. The value of this parameter is in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

When the acquirer is Hundsun, the value of this parameter may be skewed. For more information about the error correction information, see Acquirer Hundsun and Sample 2.

When the acquirer is 2C2P and the Interchange++ pricing model is used, the value of this parameter may represent the error correction information. For more information about error correction information, see Interchange++ pricing model and Sample 3.

feeCurrency

MANDATORY String (3)

The currency of feeAmountValue, specified by a 3-letter currency code as defined in ISO 4217.

taxFeeAmountValue

OPTIONAL String (16)

The tax fee amount in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

When the acquirer is Hundsun, the value of this parameter may be skewed. For more information about the error correction information, see Acquirer Hundsun and Sample 2.

taxFeeCurrency

OPTIONAL String (3)

The currency of taxFeeAmountValue, specified by a 3-letter currency code as defined in ISO 4217.

processingFeeAmountValue

OPTIONAL String (16)

The amount of the processing fee that is charged for the payment processing services Alipay provided for each transaction. The value of this parameter is in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

processingFeeCurrency

OPTIONAL String (3)

The currency of processingFeeAmountValue. The value of processingFeeCurrency is specified by a 3-letter currency code as defined in ISO 4217.

nonGuaranteeCouponValue

OPTIONAL String (16)

The merchant discount amount, which is not settled to the merchant and is in the smallest unit of the corresponding currency.

nonGuaranteeCouponCurrency

OPTIONAL String (3)

The merchant discount amount, which is not settled to the merchant. The value of this parameter is in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

disputeHandlingFee

OPTIONAL String (16)

The amount of the fee that is charged by the acquirer to the merchant for handling a dispute. The value of this parameter is in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

disputeHandlingFeeCurrency

OPTIONAL String (3)

The currency of disputeHandlingFee. The value of this parameter is specified by a 3-letter currency code as defined in ISO 4217.

disputeReverseFee

OPTIONAL String (16)

The amount of the reverse fee that is charged by the acquirer to the merchant. The value of this parameter is in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

This parameter is specified when the merchant accepts the dispute and initiates a defense for the dispute.

disputeReverseFeeCurrency

OPTIONAL String (3)

The currency of disputeReverseFee. The value of this parameter is specified by a 3-letter currency code as defined in ISO 4217.

interchangeFeeAmountValue

OPTIONAL String (16)

The fee that is charged by the issuing bank. The value of this parameter has the following features:

  • In major units of the corresponding currency (For example, dollars for USD, and yen for JPY).
  • Accurate to eight decimal places in the settlement details report, and is rounded to two decimal places using Banker's rounding in the settlement summary report.

This parameter is specified when paymentMethodType is CARD and the Interchange++ pricing model is used.

interchangeFeeCurrency

OPTIONAL String (3)

The currency of interchangeFeeAmountValue, specified by a 3-letter currency code as defined in ISO 4217.

This parameter is specified when paymentMethodType is CARD and the Interchange++ pricing model is used.

schemeFeeAmountValue

OPTIONAL String (16)

The fee that is charged by the card scheme. The value of this parameter has the following features:

  • In major units of the corresponding currency (For example, dollars for USD, and yen for JPY).
  • Accurate to eight decimal places in the settlement details report, and is rounded to two decimal places using the banker's rounding in the settlement summary report.

This parameter is specified when paymentMethodType is CARD and the Interchange++ pricing model is used.

schemeFeeCurrency

OPTIONAL String (3)

The currency of schemeFeeAmountValue, specified by a 3-letter currency code as defined in ISO 4217.

This parameter is specified when paymentMethodType is CARD and the Interchange++ pricing model is used.

acquirerMarkupAmountValue

OPTIONAL String (16)

The fee that is charged by the acquirer. The value of this parameter is in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

This parameter is specified when paymentMethodType is CARD and the Interchange++ pricing model is used.

acquirerMarkupCurrency

OPTIONAL String (3)

The currency of acquirerMarkupAmountValue, specified by a 3-letter currency code as defined in ISO 4217.

This parameter is specified when paymentMethodType is CARD and the Interchange++ pricing model is used.

refundFeeAmountValue

OPTIONAL String (16)

The commission fee charged by the acquirer for a refund. The value of this parameter is in major units of the corresponding currency (For example, dollars for USD, and yen for JPY).

This parameter may be specified when the value of transactionType is REFUND.

refundFeeCurrency

OPTIONAL String (3)

The currency of refundFeeAmountValue, specified by a 3-letter currency code as defined in ISO 4217.

This parameter may be specified when the value of transactionType is REFUND.

Table 1. Parameters and descriptions in the settlement summary report

Note: Use the header parameters to parse the transaction details report. The parameter order in the report downloaded from the SFTP server and Alipay Global Merchant Portal may not match the parameter order displayed in Table 1.

Error correction information

The settlement report you obtained may contain the error correction information in the following scenarios.  

Acquirer: Hundsun

The acquirer Hundsun only provides the final settlement total amount. Therefore, Alipay calculates the settlement details of each transaction for you. Due to the different calculation methods, the total settlement data calculated by Alipay and Hundsun may be different, so Alipay provides the error correction information about the amount calculation differences in the settlement report. The error correction information is displayed on the second-to-last line of the report and is represented by settlementAmountValue, feeAmountValue, and taxFeeAmountValue. For example:

  • If the total settlementAmountValue values calculated by Hundsun and Alipay are respectively 37164 and 37140, the error correction information for settlementAmountValue is 24.
  • If the total feeAmountValue values calculated by Hundsun and Alipay are respectively 760 and 760, the error correction information for feeAmountValue is 0.
  • If the total taxFeeAmountValue values calculated by Hundsun and Alipay are respectively 76 and 100, the error correction information for taxFeeAmountValue is -24.

The final settlement amount to you is subject to the settlement amount provided by Hundsun. For information about the settlement report when the acquirer is Hundsun, see Sample 2.

Interchange++ pricing model

Interchange++ is a pricing model that consists of the fees charged by the relevant issuing bank, card scheme, and acquirer for processing every transaction. This pricing model is transparent because it offers the most detailed breakdown of the true costs. The Interchange++ pricing model includes the following three types of fees:

  • Interchange fee: The fee that is charged by the issuing bank.
  • Scheme fee (first+): The fee that is charged by the card scheme.
  • Acquirer fee (second+): The fee that is charged by the acquirer.

When the acquirer is 2C2P and the Interchange++ pricing model is used, the settlement reports may have error correction information. The error correction information represents the discrepancy between the fee that should be charged and the fee that is actually charged, and is presented on the second-to-last line through the feeAmountValue field of the settlement reports.

  • If the value of feeAmountValue is positive, it means the fee that should be charged is less than the fee that is actually charged, and the acquirer needs to pay you the discrepancy fee.
  • If the value of feeAmountValue is negative, it means the fee that should be charged is greater than the fee that is actually charged, and you need to pay the acquirer the discrepancy fee.

The acquirer sends the error correction information to Alipay irregularly. Alipay sends you the error correction information through the settlement reports.

In addition, under the Interchange++ pricing model, there may be a delay in the collection of Interchange++ fees. For example, for a transaction that happened on January 3, 2023, the interchange fee charged by the issuing bank was not settled in the same batch as other transactions, but the fee was charged in the next batch settlement. For more information about the settlement report that contains the error correction information under the Interchange++ pricing model, see Sample 3.

Report samples

The following samples show settlement details reports in different scenarios.

Sample 1 (Standard report)

On the transaction day of December 25, 2018, the merchant with an ID of 102218800000000**** had two transactions, one for a payment and the other for a refund. After Alipay settled with you and you received the bank receipt, Alipay generated a settlement summary report in CSV. The details of the report are as follows:

copy
settlementBatchId,customerId,acquirer,summaryType,settlementTime,count,settlementAmountValue,settlementCurrency,feeAmountValue,feeCurrency,processingFeeAmountValue,processingFeeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,disputeHandlingFee,disputeHandlingFeeCurrency,disputeReverseFee,disputeReverseFeeCurrency,interchangeFeeAmountValue,interchangeFeeCurrency,schemeFeeAmountValue,schemeFeeCurrency,acquirerMarkupAmountValue,acquirerMarkupCurrency,refundFeeAmountValue,refundFeeCurrency
201812261102104****,102218800000000****,Alipay_SG,TOTAL,2018-12-26T10:00:00+08:30,2,725,USD,-25,USD,,,,,,,,,,,,,,,,
201812261102104****,102218800000000****,Alipay_SG,PAYMENT,2018-12-26T10:00:00+08:30,1,1450,USD,-50,USD,,,,,,,,,,,,,,,,
201812261102104****,102218800000000****,Alipay_SG,REFUND,2018-12-26T10:00:00+08:30,1,-725,USD,25,USD,,,,,,,,,,,,,,,,
<END>

📎Settlement summary report-Sample 1.csv

In this example, the settlement currency (settlementCurrency) is USD, and the values of the settlement amount (settlementAmountValue) under different settlement types (summaryType) are as follows:

  • PAYMENT: For the payment, the value of settlementAmountValue is 1450, indicating that Alipay needs to pay the merchant 1450 USD.
  • REFUND: For the refund, the value of settlementAmountValue is -725, indicating that Alipay needs to refund the merchant 735 USD.
  • TOTAL: For the total settlement amount, the value of settlementAmountValue is 725, indicating that after calculating the settlement amounts of payment and refund, Alipay needs to settle a net settlement amount of 725 USD to the merchant.

Sample 2 (Acquirer Hundsun)

The following settlement summary report is an example of when the acquirer is Hundsun. The report includes ten payments and one refund, as well as the error correction information on the second-to-last line. The settlement date for the transactions under this batch was October 30th, 2022. After Alipay settled with you and you received the bank receipt, Alipay generated a settlement summary report in CSV. The details of the report are as follows:

copy
settlementBatchId,customerId,acquirer,summaryType,settlementTime,count,settlementAmountValue,settlementCurrency,feeAmountValue,feeCurrency,taxFeeAmountValue,taxFeeCurrency,processingFeeAmountValue,processingFeeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,interchangeFeeAmountValue,interchangeFeeCurrency,schemeFeeAmountValue,schemeFeeCurrency,acquirerMarkupAmountValue,acquirerMarkupCurrency,refundFeeAmountValue,refundFeeCurrency
202210190903110****,OB10****,Hundsun,PAYMENT,2022-10-30T23:00:00+08:00,11,1056,JPY,-44,JPY,0,JPY,,,,,,,,,,,,
202210190903110****,OB10****,Hundsun,REFUND,2022-10-30T23:00:00+08:00,1,-96,JPY,4,JPY,0,JPY,,,,,,,,,,,,
202210190903110****,OB10****,Hundsun,TOTAL,2022-10-30T23:00:00+08:00,13,956,JPY,-40,JPY,-4,JPY,,,,,,,,,,,,
202210190903110****,OB10****,Hundsun,default,2022-10-30T23:00:00+08:00,1,-4,JPY,0,JPY,-4,JPY,,,,,,,,,,,,
<END>

📎Settlement summary report-Sample 2.csv

In this sample, pay attention to the following information:

  • feeAmountValue (transactionType = default): 0
  • feeCurrency (transactionType = default): JPY
  • taxFeeAmountValue (transactionType = default): -4
  • taxFeeCurrency (transactionType = default): JPY
  • settlementAmountValue (transactionType = default): -4
  • settlementCurrency (transactionType = default): JPY
  • settlementAmountValue (transactionType = PAYMENT): 1056
  • settlementCurrency (transactionType = PAYMENT): JPY
  • settlementAmountValue (transactionType = REFUND): -96
  • settlementCurrency (transactionType = REFUND): JPY
  • settlementAmountValue (transactionType = TOTAL): 956
  • settlementCurrency (transactionType = TOTAL): JPY

where, in the error correction information line, that is, when the value of transactionType is default, the values of feeAmountValue and taxFeeAmountValue are respectively 0 and -4, and the fee currencies are all JPY. The total settlement amount after the calculation is four yen. That is, the value of settlementAmountValue is -4 and the value of settlementCurrency is JPY, which indicates that there is a difference of four yen in the settlement amount calculated by Hundsun and Alipay. In this report, the total settlement amount for payment is 1056 yen, and the total settlement amount for refund is -96 yen. After summarizing all the settlement amounts of payments, refunds, and error correction part, the final settlement amount is 956 yen, so when the transactionType is TOTAL, the values of settlementAmountValue and settlementCurrency are 956 and JPY respectively.

Sample 3 (Interchange++ pricing model)

The following settlement summary report is an example of when the Interchange++ pricing model is used. The settlement report contains an authorization, two captures, a refund, and the error correction information of previous transactions returned by the acquirer. The error correction information is displayed on the second-to-last line of the report.

copy
settlementBatchId,customerId,acquirer,summaryType,settlementTime,count,settlementAmountValue,settlementCurrency,feeAmountValue,feeCurrency,taxFeeAmountValue,taxFeeCurrency,processingFeeAmountValue,processingFeeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,disputeHandlingFee,disputeHandlingFeeCurrency,disputeReverseFee,disputeReverseFeeCurrency,interchangeFeeAmountValue,interchangeFeeCurrency,schemeFeeAmountValue,schemeFeeCurrency,acquirerMarkupAmountValue,acquirerMarkupCurrency,refundFeeAmountValue,refundFeeCurrency
2C2PXXXXXX0101,Oxxxx742,2C2P_SG,AUTHORIZATION,2023-01-09T02:45:29+08:00,1,-3,HKD,,,,,-1,HKD,,,,,,,,,-2,HKD,,,,
2C2PXXXXXX0101,Oxxxx742,2C2P_SG,CAPTURE,2023-01-09T02:45:29+08:00,2,91,HKD,,,-1,HKD,-1,HKD,,,,,,,-4,HKD,-2,HKD,-1,HKD,,
2C2PXXXXXX0101,Oxxxx742,2C2P_SG,REFUND,2023-01-09T02:45:29+08:00,1,-99,HKD,,,,,-1,HKD,,,,,,,4,HKD,-2,HKD,,,,
2C2PXXXXXX0101,Oxxxx742,2C2P_SG,TOTAL,2023-01-09T02:45:29+08:00,5,-511,HKD,,,0,HKD,,,,,,,,,-1,HKD,-2,HKD,-1,HKD,,
2C2PXXXXXX0101,Oxxxx742,2C2P_SG,default,2023-01-09T02:45:29+08:00,1,-500,HKD,-500,HKD,,,,,,,,,,,,,,,,,,
<END>

📎Settlement summary report-Sample 3.csv

In this sample, pay attention to the following information:

  • feeAmountValue (summaryType = default): -500
  • feeCurrency (summaryType = default): HKD
  • settlementAmountValue (summaryType = default): -500
  • settlementCurrency (summaryType = default): HKD
  • settlementAmountValue (summaryType = AUTHORIZATION): -3
  • settlementCurrency (summaryType = AUTHORIZATION): HKD
  • settlementAmountValue (summaryType = CAPTURE): 91
  • settlementCurrency (summaryType = CAPTURE): HKD
  • settlementAmountValue (summaryType = REFUND): -99
  • settlementCurrency (summaryType = REFUND): HKD
  • settlementAmountValue (summaryType = TOTAL): -511
  • settlementCurrency (summaryType = TOTAL): HKD

where, when the summaryType is default, the values of feeAmountValue and feeCurrency are -500 and HKD respectively. That is, you need to pay an additional fee of 500 HKD to the acquirer, and the error correction value of settlementAmountValue is -500. In this batch, there is one authorization with a settlement amount of -3 HKD, two captures with a settlement amount of 96 HKD, and one refund with a settlement amount of -99 HKD. Therefore, the final settlement amount is the sum of the settlement amounts of different transaction types, which is -511 HKD. That is, when the summaryType is TOTAL, the value of settlementAmountValue is -511, and the value of settlementCurrency is HKD.

Note: In the same settlement batch, the error correction amounts in the settlement details report and the settlement summary report are the same.

Sample 4 (No transaction)

copy
settlementBatchId,customerId,acquirer,summaryType,settlementTime,count,settlementAmountValue,settlementCurrency,feeAmountValue,feeCurrency,processingFeeAmountValue,processingFeeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,disputeHandlingFee,disputeHandlingFeeCurrency,disputeReverseFee,disputeReverseFeeCurrency,interchangeFeeAmountValue,interchangeFeeCurrency,schemeFeeAmountValue,schemeFeeCurrency,acquirerMarkupAmountValue,acquirerMarkupCurrency,refundFeeAmountValue,refundFeeCurrency
<END>

📎Settlement summary report-Sample 4.csv

Note: When there is no transaction, the SFTP server and Alipay Global Merchant Portal will not generate transaction details reports. If you need the empty report that has no transaction, you can contact Alipay Merchant Service technical support (overseas_support@service.alibaba.com)  to configure it in the SFTP server.