Settlement summary report
The settlement summary report provides settlement overview information of all sub-merchants on T day.
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, Antom will generate this ID. |
merchantId | MANDATORY String (64) The unique ID assigned by Antom to identify a marketplace or a sub-merchant. |
referenceMerchantId | OPTIONAL String (64) The unique ID of a sub-merchant that directly provides services or goods to users, assigned by the marketplace to its sub-merchants. The value of this parameter needs to be the same as that of the referenceMerchantId parameter in the original payment or authorization request. If the value of merchantId represents a marketplace, the value of this parameter is empty. |
settlementTime | MANDATORY String (64) The date and time when Antom settles with the sub-merchant, in the format of YYYY-MM-DDTHH:MM:SS+hh:mm as defined in ISO 8601. |
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. |
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 Antom Global Merchant Portal may not match the parameter order displayed in Table 1.
Report sample
The following sample shows the settlement summary report of transactions that were settled on November 08, 2023.
merchantId | referenceMerchantId | settlementBatchId | settlementAmountValue | settlementCurrency | settlementTime |
2159110286271340 | seller1023 | 202311071129052119 | 100 | BRL | 2023-11-08T01:30:45+08:00 |
Download a sample of the settlement summary report in CSV format: 📎Settlement summary report.csv