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. You can obtain this report through the SFTP server or POP 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:
|
settlementTime | MANDATORY String (64) The date and time when the settlement file is generated, in the format of |
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). |
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). |
feeCurrency | MANDATORY String (3) The currency of feeAmountValue, 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). |
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 POP Portal may not match the parameter order displayed in Table 1.
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 POP settled with you and you received the bank receipt, POP generated a settlement summary report in CSV. The details of the report are as follows:
settlementBatchId,customerId,acquirer,summaryType,settlementTime,count,settlementAmountValue,settlementCurrency,feeAmountValue,feeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency
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 is1450
, 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 is725
, 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 (No transaction)
settlementBatchId,customerId,acquirer,summaryType,settlementTime,count,settlementAmountValue,settlementCurrency,feeAmountValue,feeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency
<END>
📎Settlement summary report-Sample 2.csv
Note: When there is no transaction, the SFTP server will not generate transaction details reports. If you need the empty report that has no transaction, you can contact Alipay Merchant Service technical support to configure it in the SFTP server.