Settlement details report
The settlement details report contains transaction settlement details for all sub-merchants on T day.
Report details
The settlement details 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 details are represented by the corresponding values of the parameters.
The following table shows the parameters in the settlement details 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. |
transactionId | MANDATORY String (64) The unique ID that is assigned by Antom to identify a transaction. The value of this parameter follows these rules:
|
originalTransactionId | OPTIONAL String (64) An identifier for the original transaction.
|
transactionRequestId | MANDATORY String (64) The unique ID that is assigned by the marketplace to identify a transaction request. The value of this parameter is identical to the value of paymentRequestId for a payment, or the value of refundRequestId for a refund. When transactionType is |
referenceTransactionId | OPTIONAL String (64) The unique ID assigned by the marketplace to identify a transaction. The value of this parameter is identical to that of referenceOrderId for a payment. When transactionType is |
transactionType | MANDATORY String Transaction type. Possible values are:
|
transactionTime | The date and time when the corresponding transaction reaches a final status of success, in the format of YYYY-MM-DDTHH:MM:SS+hh:mm as defined in ISO 8601. |
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. |
quoteCurrencyPair | OPTIONAL String (16) The currency pair of the settlement currency and the transaction currency, which is provided by the foreign exchange partner. The two currencies are separated with a slash and use a 3-letter ISO-4217 currency code, such as The value of this parameter is empty when the settlement currency is the same as the transaction currency. |
quotePrice | OPTIONAL Decimal (20) The quotation of the exchange rate between two currencies in the currency pair specified in the quoteCurrencyPair parameter. The value of this parameter is empty when the settlement currency is the same as the transaction currency. |
originalTransactionRequestId | OPTIONAL String (64) The original payment request ID of the transaction when the transaction type is |
Table 1. Parameters and descriptions in the settlement details 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 details report of transactions that were settled on November 08, 2023.
merchantId | referenceMerchantId | settlementBatchId | settlementAmountValue | settlementCurrency | quoteCurrencyPair | quotePrice | settlementTime | transactionType | transactionId | transactionRequestId | referenceTransactionId | originalTransactionId | originalTransactionRequestId | transactionTime |
2159110286271340 | seller1023 | 202311071129052119 | -500 | BRL | None | None | 2023-11-08T01:30:45+08:00 | REFUND | 20231102114010801300159550284114681 | refundRequestId_1698921056397 | referenceOrderId_1698918723386 | 20231102114010800100159550201286009 | paymentRequestId_1698918723386 | 2023-11-02T18:30:57+08:00 |
2159110286271340 | seller1023 | 202311071129052119 | -100 | BRL | None | None | 2023-11-08T01:30:45+08:00 | REFUND | 20231107114010801300159390283229531 | refundRequestId_169892105631237 | referenceOrderId_1698655232176 | 20231030114010800100159390200618039 | paymentRequestId_1698655232176 | 2023-11-07T13:37:00+08:00 |
2159110286271340 | seller1023 | 202311071129052119 | 500 | BRL | None | None | 2023-11-08T01:30:45+08:00 | PAYMENT | 20231107114010800100159080201687672 | paymentRequestId_1699341641907 | referenceOrderId_1699341641907 | None | None | 2023-11-07T15:20:49+08:00 |
2159110286271340 | seller1023 | 202311071129052119 | 100 | BRL | None | None | 2023-11-08T01:30:45+08:00 | CAPTURE | 20231107114010800100159550201522034 | paymentRequestId_1699346795334 | referenceOrderId_1699346795334 | 20231107114010800100159550201522034 | paymentRequestId_1699346795334 | 2023-11-07T16:46:42+08:00 |
2159110286271340 | seller1023 | 202311071129052119 | 100 | BRL | None | None | 2023-11-08T01:30:45+08:00 | CAPTURE | 20231107114010807000159400237333472 | paymentRequestId_1699355610724 | referenceOrderId_1699355610724 | 20231107114010800100159400201857260 | paymentRequestId_1699355610724 | 2023-11-07T19:13:39+08:00 |
Download a sample of the settlement details report in CSV format: 📎Settlement details report.csv