Antom, leading provider of tailored payment solutionsAntom, leading provider of tailored payment solutions

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 when the batch settlement is processed. You can obtain this report through the SFTP server or Antom Dashboard.

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 assigned by Antom to identify a settlement period, which is the same as the settlement batch number in the settlement summary file.

customerId

MANDATORY String (64)

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

PSP

MANDATORY String (64)

Payment service provider. The name of the acquirer that processes the transactions, specifically referring to the acquirer that provides acquiring and funds settlement services for the merchant.

summaryType

MANDATORY String (16)

The type of the settlement summary. Valid values are:

  • AUTHORIZATION: indicates a summary of authorized payments within a specific period.
  • PAYMENT: indicates a payment summary within a specific period.
  • CAPTURE: indicates a capture summary within a specific period.
  • REFUND: indicates a refund summary within a specific period.
  • CANCEL: indicates a cancellation summary within a specific period.
  • DISPUTE: indicates a dispute summary within a specific period.
  • ADJUSTMENT_FEE: indicates adjustment fees. For card payments, adjustments may be made due to changes, errors, or other reasons, including but not limited to fees or additional charges imposed or stipulated by payment system operators.
  • TOTAL: indicates a total settlement summary within a specific period.
  • REFUND_REVERSAL: indicates a summary of refund reversals within a specific period, which usually occurs with payment methods that do not support refunds to the original route. The funds will be returned to your account.
  • PAYMENT_REVERSAL: indicates a summary of payment reversals within a specific period, which usually occurs with payment methods that do not support refunds to the original route. The funds will be 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_WITHHELD: indicates the withheld collateral funds, meaning that if Antom requires a collateral deposit from you, the collateral amount will be deducted from the settlement batch amount.
  • RESERVE: indicates the withheld of reserve funds, meaning that if you need to retain part of the funds to prepare for potential refunds, and you increase the reserve threshold in Antom Dashboard, Antom will deduct the corresponding reserve amount from the settlement batch.
  • RESERVE_RELEASED: indicates the release of reserve funds, meaning that when you lower the reserve threshold in Antom Dashboard, Antom will release the excess reserve funds to the settlement batch and settle them to you.
  • COLLATERAL_RELEASED: indicates the release of collateral funds, meaning that if Antom no longer needs to withhold additional collateral, the excess collateral amount will be released to the settlement batch and settled to you accordingly.
  • RAPID_DISPUTE_RESOLUTION: indicates a dispute process with rapid dispute resolution (RDR).
  • CDRN: indicates a cardholder dispute resolution networkprocess (CARDHOLDER_DISPUTE_RESOLUTION_NETWORK).

settlementInitiatedDate

MANDATORY String (64)

The time when a settlement report is generated, on the day the batch settlement is processed,  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)

Net settlement amount after deduction of fees for orders converted to settlement currency, displayed in the unit of the settlementCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

settlementCurrency

MANDATORY String (3)

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

paymentMethodFeeAmountValue

OPTIONAL String (16)

The amount of the payment method processing fee that is charged by Antom, displayed in the unit of the paymentMethodFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

paymentMethodFeeCurrency

OPTIONAL String (3)

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

taxFeeAmountValue

OPTIONAL String (16)

The tax fee amount, displayed in the unit of the taxFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

taxFeeCurrency

MANDATORY 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 charged for the payment processing services provided by Antom for each transaction. This parameter’s value is displayed in the unit of the processingFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

processingFeeCurrency

OPTIONAL String (3)

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

disputeHandlingFee

OPTIONAL String (16)

The amount of the fee charged by Antom to the merchant for handling a dispute. This parameter’s value is displayed in the unit of the disputeHandlingFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when transactionType is DISPUTE, and Antom charges or refunds the fee to you.

disputeHandlingFeeCurrency

OPTIONAL String (3)

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

interchangeFeeAmountValue

OPTIONAL String (16)

The fee charged by the issuing bank, displayed in the unit of the interchangeFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when paymentMethodType is CARD, the Interchange++ pricing model is used, and the issuing bank charges or refunds the fee to you.

interchangeFeeCurrency

OPTIONAL String (3)

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

schemeFeeAmountValue

OPTIONAL String (16)

The fee charged by the card scheme, displayed in the unit of the schemeFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when paymentMethodType is CARD, the Interchange++ pricing model is used, and the card scheme charges or refunds the fee to you.

schemeFeeCurrency

OPTIONAL String (3)

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

acquirerMarkupAmountValue

OPTIONAL String (16)

The fee charged by Antom, displayed in the unit of the acquirerMarkupCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when paymentMethodType is CARD, the Interchange++ pricing model is used, and Antom charges or refunds the fee to you.

acquirerMarkupCurrency

OPTIONAL String (3)

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

refundFeeAmountValue

OPTIONAL String (16)

The commission fee charged by Antom for a refund, displayed in the unit of the refundFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when transactionType is REFUND, and Antom charges the fee to you.

refundFeeCurrency

OPTIONAL String (3)

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

financingFeeAmountValue

OPTIONAL String (16)
The fee amount for the installment payment charged by Antom to you, displayed in the unit of the financingFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when paymentMethodType is CARD, the parameter installmentsNum has a value, and Antom charges or refunds the fee to you.

financingFeeCurrency

OPTIONAL String (3)

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

rdrFeeAmountValue

OPTIONAL String (16)

The fee amount for rapid dispute resolution (RDR) transactions charged by Antom to you. This parameter’s value is displayed in the unit of the rdrFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when you activates the RDR service through Antom, transactionType is RAPID_DISPUTE_RESOLUTION, and Antom charges or refunds the fee to you.

rdrFeeCurrency

OPTIONAL String (3)

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

anticipationFeeAmountValue

OPTIONAL String (16)

The fee amount for the settlement period acceleration charged by Antom to merchants. This parameter’s value is displayed in the unit of the anticipationFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when the buyer uses Brazilian local cards for installment payments, or when the days of delay for customer fund settlement are less than T+26, and Antom charges or refunds the fee to you.

anticipationFeeCurrency

OPTIONAL String (3)

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

riskDecisionServiceFeeAmountValue

OPTIONAL String (16)

Risk control decision-making fee, displayed in the unit of the riskDecisionServiceFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This fee will be charged when the merchant does not sign up for the risk control compensation capability, while will not be charged to merchants who sign up for the risk control compensation capability. This fee is only charged when transactionType is  AUTHORIZATION and is not refundable.

riskDecisionServiceFeeCurrency

OPTIONAL String (3)

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

riskManagementFeeAmountValue

OPTIONAL String (16)

Risk control management fee, displayed in the unit of the riskManagementFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

The fee will be charged when the merchant signes up for the risk control compensation capability, while will not be charged to merchants who do not sign up for the risk control compensation capability. This fee is only charged when transactionType is CAPTURE and is not refundable.

riskManagementFeeCurrency

OPTIONAL String (3)

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

cdrnFeeAmountValue

OPTIONAL String (16)

The fee amount for cardholder dispute resolution network (CDRN) transactions charged by Antom to you. The value of this parameter is displayed in the unit of the cdrnFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when transactionType is CDRN, you activates the CDRN service through Antom, and Antom charges or refunds the fee to you.

cdrnFeeCurrency

OPTIONAL String (3)

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

iofFeeAmountValue

OPTIONAL String (16)

The IOF (Imposto sobre Operações Financeiras) fee is a Brazilian federal tax mandated specific financial operations including foreign exchange, credit card international settlements, and cross-border investments. The value of this parameter is displayed in the unit of the iofFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when the Brazilian federal government levies this tax.

iofFeeCurrency

OPTIONAL String (3)

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

withholdingTaxAmountValue

OPTIONAL String (16)

This field indicates the amount of tax withheld at source in accordance with the relevant local tax regulations. It represents the portion of the transaction that is retained by the payer and remitted to the appropriate tax authority as withholding tax. The value is typically calculated based on the applicable tax rate and may vary depending on the nature of the transaction and the classification of the parties involved. 

The value of this parameter is displayed in the unit of the withholdingTaxFeeCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when the Philippine federal government levies this tax.

withholdingTaxFeeCurrency

OPTIONAL String (3)

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

fxFeeAmountValue

OPTIONAL String (16)

The amount of the processing fee that is charged for the FX (foreign exchange) conversion services Antom provided for each transaction. The value of this parameter is displayed in the unit of the fxFeeAmountCurrency. (For example, if the currency is USD and the amount is $1.00, set the value of this parameter to 1.00. Or, if the currency is JPY and the amount is ¥1, set the value of this parameter to 1.)

This parameter has a value when Antom charges or refunds the fee to you.

fxFeeAmountCurrency

OPTIONAL String (3)

The currency of fxFeeAmountValue, 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 Dashboard 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 December 17, 2024, the merchant with an ID of 21881201642xxxxx had 17 transactions, including authorization, refund, request for capture, payment, cancellation, dispute, refund failure, settlement fee, chargeback defense, final payment, collateral release, collateral withholding, reserve withholding, reserve release, and RDR dispute. After Antom settled with you and you received the bank receipt, Antom generated a settlement details report in CSV. The details of the report are as follows:

copy
settlementBatchId,customerId,PSP,summaryType,settlementInitiatedDate,count,settlementAmountValue,settlementCurrency,paymentMethodFeeAmountValue,paymentMethodFeeCurrency,taxFeeAmountValue,taxFeeCurrency,processingFeeAmountValue,processingFeeCurrency,disputeHandlingFee,disputeHandlingFeeCurrency,interchangeFeeAmountValue,interchangeFeeCurrency,schemeFeeAmountValue,schemeFeeCurrency,acquirerMarkupAmountValue,acquirerMarkupCurrency,refundFeeAmountValue,refundFeeCurrency,financingFeeAmountValue,financingFeeCurrency,rdrFeeAmountValue,rdrFeeCurrency,anticipationFeeAmountValue,anticipationFeeCurrency,riskDecisionServiceFeeAmountValue,riskDecisionServiceFeeCurrency,riskManagementFeeAmountValue,riskManagementFeeCurrency,cdrnFeeAmountValue,cdrnFeeCurrency,iofFeeAmountValue,iofFeeCurrency,withholdingTaxAmountValue,withholdingTaxFeeCurrency,fxFeeAmountValue,fxFeeAmountCurrency
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,AUTHORIZATION,2024-12-17T05:16:17+08:00,1,-0.24346,USD,,,,,,,,,,,-0.23346,USD,,,,,,,,,,,-0.01,USD,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,PAYMENT,2024-12-17T05:16:17+08:00,2,144.25,USD,-2.19,USD,,,-0.11,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,CAPTURE,2024-12-17T05:16:17+08:00,1,4.85,USD,-0.18,USD,,,-0.15,USD,,,,,,,,,,,,,,,,,,,-0.01,USD,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,CANCEL,2024-12-17T05:16:17+08:00,1,-31.13,USD,0.47,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,DISPUTE,2024-12-17T05:16:17+08:00,1,-325.79,USD,,,,,,,-15,USD,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,REFUND,2024-12-17T05:16:17+08:00,2,-284.87,USD,4.72,USD,,,,,,,,,,,,,-0.32,USD,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,REFUND_REVERSAL,2024-12-17T05:16:17+08:00,1,289.63,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,SETTLEMENT_FEE,2024-12-17T05:16:17+08:00,1,0,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,DISPUTE_REVERSAL,2024-12-17T05:16:17+08:00,1,240.05,USD,-6.31,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,PAYMENT_REVERSAL,2024-12-17T05:16:17+08:00,1,15.39,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,COLLATERAL_RELEASED,2024-12-17T05:16:17+08:00,1,378.71,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,COLLATERAL_WITHHELD,2024-12-17T05:16:17+08:00,1,-451.87,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,RESERVE_RELEASED,2024-12-17T05:16:17+08:00,1,11.3,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,RESERVE,2024-12-17T05:16:17+08:00,1,-3.7,USD,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,RAPID_DISPUTE_RESOLUTION,2024-12-17T05:16:17+08:00,1,-875.88,USD,,,,,,,0,USD,,,,,,,,,,,,,,,,,,,,,,,,,,
"2024121619607xxxxx ","21881201642xxxxx ",Antom_SG,TOTAL,2024-12-17T05:16:17+08:00,17,-889.30346,USD,-3.49,USD,,,-0.26,USD,0,USD,,,-0.23346,USD,,,-0.32,USD,,,,,,,,,,,,,,,,,,
<END>

📎Settlement summary report-Sample 1.csv

Sample 2 (No transaction)

copy
settlementBatchId,customerId,PSP,summaryType,settlementInitiatedDate,count,settlementAmountValue,settlementCurrency,paymentMethodFeeAmountValue,paymentMethodFeeCurrency,taxFeeAmountValue,taxFeeCurrency,processingFeeAmountValue,processingFeeCurrency,disputeHandlingFee,disputeHandlingFeeCurrency,interchangeFeeAmountValue,interchangeFeeCurrency,schemeFeeAmountValue,schemeFeeCurrency,acquirerMarkupAmountValue,acquirerMarkupCurrency,refundFeeAmountValue,refundFeeCurrency,financingFeeAmountValue,financingFeeCurrency,rdrFeeAmountValue,rdrFeeCurrency,anticipationFeeAmountValue,anticipationFeeCurrency,riskDecisionServiceFeeAmountValue,riskDecisionServiceFeeCurrency,riskManagementFeeAmountValue,riskManagementFeeCurrency,cdrnFeeAmountValue,cdrnFeeCurrency,iofFeeAmountValue,iofFeeCurrency,withholdingTaxAmountValue,withholdingTaxFeeCurrency,fxFeeAmountValue,fxFeeAmountCurrency
<END>

📎Settlement summary report-Sample 2.csv

Note: When there is no transaction, the SFTP server and Antom Dashboard will not generate reports. If you need the empty report that has no transaction, you can contact Antom Merchant Service technical support (TechnicalService@antom.com)  to configure it in the SFTP server.