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

Settlement details report

The settlement details report contains transaction settlement details for all transactions within a settlement period. The report is generated along with the settlement summary report. You can obtain this report through the SFTP server or APO Dashboard.

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 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, APO 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.

acquirerReferenceNo

OPTIONAL String (64)

The unique ID assigned by the non-Antom acquirer for the transaction.

This parameter is specified when the transaction is settled by the non-Antom acquirer.

referenceMerchantId

OPTIONAL String (64)

The unique ID of the sub-merchant that directly provides services or goods to users, is assigned by the primary merchant to its sub-merchant.

The value of this field needs to be the same as that of the referenceMerchantId field in the original payment or authorization request.

referenceStoreId

OPTIONAL String (64)

The unique ID of the store that belongs to the merchant, is assigned by the primary merchant to its sub-merchant.

transactionId

MANDATORY String (64)

The unique ID that is assigned by APO to identify a transaction. The value of this parameter follows these rules:

  • When transactionType is PAYMENT, CANCEL, or AUTHORIZATION, the value of this parameter is identical to that of paymentId.
  • When transactionType is CAPTURE, the value of this parameter is identical to that of captureId.
  • When transactionType is REFUND, the value of this parameter is identical to that of refundId.
  • When transactionType is DISPUTE or DISPUTE_REVERSAL, the value of this parameter is identical to that of disputeId.
  • When transactionType is VOID, REFUND_REVERSAL, SETTLEMENT_FEE、COLLATERAL_WITHHOLDING, RESERVE_WITHHOLDING,  RESERVE_RELEASE, COLLATERAL_RELEASE, the value of this parameter is APO's internal ID.

originalTransactionId

OPTIONAL String (64)

An identifier for the original transaction.

  • When transactionType is PAYMENT, CANCEL, or AUTHORIZATION, the value of this parameter is empty.
  • When transactionType is VOID, the value of this parameter is identical to paymentId of the original authorization.
  • When transactionType is REFUND, the value of this parameter is identical to paymentId of the original payment or authorization.
  • When transactionType is CAPTURE, the value of this parameter is identical to paymentId of the original authorization.
  • When transactionType is DISPUTE, the value of this parameter is identical to that of paymentId of the original authorization.

transactionRequestId

MANDATORY String (64)

The unique ID that is assigned by the merchant 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 DISPUTE, the value of this parameter is empty.

referenceTransactionId

OPTIONAL String (64)

The unique ID assigned by the merchant that directly provides services or goods to users, to identify a transaction. The value of this parameter is identical to that of referenceOrderId for a payment.

When transactionType is CANCEL, CAPTURE, or DISPUTE, the value of this parameter is empty.

paymentMethodType

MANDATORY String (64)

The payment method for processing the payment. See Payment methods to check the valid values.

The value of this parameter is identical to that of paymentMethodType in the original payment or authorization request.

pspName

OPTIONAL String (64)

The name of the digital wallets, such as GCash.

The value of this parameter is identical to that of pspName in the original payment or authorization request.

transactionType

MANDATORY String

Transaction type. Possible values are:

  • PAYMENT: indicates a payment process.
  • REFUND: indicates a refund process.
  • CANCEL: indicates a cancellation process.
  • AUTHORIZATION: indicates an authorization process.
  • CAPTURE: indicates a capture process.
  • VOID: indicates a void authorization.
  • DISPUTE: indicates a dispute process.
  • REFUND_REVERSAL: indicates a reversed refund because the payment method is unable to correctly process the refund. The funds are returned to your account.
  • SETTLEMENT_FEE: indicates 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.

paymentTime

MANDATORY String (64)

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 the settlement file is generated, in the format of YYYY-MM-DDTHH:MM:SS+hh:mm as defined in ISO 8601.

productCode

MANDATORY String

The type of payment product that is contracted between APO and the merchant. Valid values are:

  • AGREEMENT_PAYMENT: indicates the auto debit payment.
  • CASHIER_PAYMENT: indicates the cashier payment.

The value of this parameter is identical to that of productCode in the original payment or authorization request.

transactionAmountValue

MANDATORY String (16)

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

When the Interchange++ pricing model is used, the interchange fee charged by the issuing bank and the scheme fee charged by the card scheme may be charged in subsequent settlement batches, and the value of this field is 0 in this case.

transactionCurrency

MANDATORY String (3)

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

settlementAmountValue

MANDATORY String (16)

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

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 EUR/USD.

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.

feeAmountValue

OPTIONAL 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, USD for dollars, and JPY for yen).

feeCurrency

MANDATORY String (3)

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

originalTransactionRequestId

OPTIONAL String (64)

The original payment request ID of the transaction when the transaction type is REFUND, CANCEL, or CAPTURE. Otherwise, the value of this parameter is empty.

acquirerTransactionType

OPTIONAL String

This indicates the original type of transaction as recorded by the acquirer.

acquirerCustomerId

OPTIONAL String (64)

The unique ID of merchant account asssigned by the acquirer.

acquirerBatchId

OPTIONAL String (64)

The unique ID assigned by the acquirer to a specific batch of settlement.

cardBrand

OPTIONAL String (256)

The brand of the card.

This parameter is specified when paymentMethodType is CARD.

The value of this parameter is identical to that of cardBrand in the original payment or authorization request.

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 APO 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 the transaction day of April 23 to April 25, 2025, the merchant with an ID of 21111100000xxxxx had many transactions, including a payment and a refund. After APO settled with you and you received the bank receipt, APO generated a settlement details report in CSV. The details of the report are as follows:

copy
settlementBatchId,customerId,acquirer,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,paymentMethodType,pspName,transactionType,paymentTime,settlementTime,productCode,transactionAmountValue,transactionCurrency,settlementAmountValue,settlementCurrency,quoteCurrencyPair,quotePrice,feeAmountValue,feeCurrency,originalTransactionRequestId,acquirerTransactionType,acquirerCustomerId,acquirerBatchId,cardBrand
"202505051967158148 ","2111110000022047 ",ALIPAY,," ","2188120010652099 ","20250425194010800100188060290748359  ",,"amsdmpay_cw391890_20250424_225244_111   ","amsdmorder_cw391890_20250424_225244_111  ",NAVERPAY,NAVERPAY,PAYMENT,2025-04-25T13:57:37+08:00,2025-05-06T05:18:17+08:00,CASHIER_PAYMENT,300,KRW,0.2,USD,USD/KRW,1453.592185,-0.01,USD,,,"2188120010652099   ","202505051967158148   ",
"202505051967158148 ","2111110000022047 ",ALIPAY,," ","2188120010652099 ","20250423194010801300188600268137104  ","20250423194010800100188600289907865  ","amsdmrefund_wgl02015622_20250422_195200_030  ","amsdmorder_wgl02015622_20250422_194430_371   ",ALIPAY_HK,AlipayHK,REFUND,2025-04-23T10:52:00+08:00,2025-05-06T05:18:17+08:00,CASHIER_PAYMENT,-0.6,HKD,-0.08,USD,USD/HKD,7.79879473,0,USD,"amsdmpay_wgl02015622_20250422_194430_371   ",,"2188120010652099    ","202505051967158148   ",
"202505051967158148 ","2111110000022047 ",ALIPAY,," ","2188120010652099 ","20250424194010801300188270270966417  ","20250424194010800100188270290203976  ","amsdmrefund_lutong_lu_20250423_210524_073    ","amsdmorder_lutong_lu_20250423_205848_036 ",DANA,Dana,REFUND,2025-04-24T12:05:24+08:00,2025-05-06T05:18:17+08:00,CASHIER_PAYMENT,-300,IDR,-0.02,USD,USD/IDR,17083.87736,0,USD,"amsdmpay_lutong_lu_20250423_205848_035 ",,"2188120010652099    ","202505051967158148   ",
"202505051967158148 ","2111110000022047 ",ALIPAY,," ","2188120010652099 ","20250424194010801300188390267527168  ","20250424194010900000188390289997008  ","amsdmrefund_lutong_lu_20250423_200020_618    ","amsdmorder_lutong_lu_20250423_195540_531 ",ALIPAY_HK,AlipayHK,REFUND,2025-04-24T11:00:21+08:00,2025-05-06T05:18:17+08:00,AGREEMENT_PAYMENT,-0.3,HKD,-0.04,USD,USD/HKD,7.79789019,0,USD,"amsdmpay_lutong_lu_20250423_195540_531   ",,"2188120010652099    ","202505051967158148   ",
"202505051967158148 ","2111110000022047 ",ALIPAY,," ","2188120010652099 ","20250424194010800100188030290274601  ",,"amsdmpay_lutong_lu_20250423_222658_767  ","amsdmorder_lutong_lu_20250423_222658_767 ",DANA,Dana,PAYMENT,2025-04-24T13:28:38+08:00,2025-05-06T05:18:17+08:00,CASHIER_PAYMENT,300,IDR,0.02,USD,USD/IDR,17083.87736,0,USD,,,"2188120010652099  ","202505051967158148   ",
<END>,,,,,,,,,,,,,,,,,,,,,,,,,,,,

📎Settlement details report-Sample 1.csv

In this example, the first transaction on April 25, 2025 was made in KRW and needs to be settled in USD, so the value of quoteCurrencyPair is USD/KRW. The exchange rate was 1 USD = 1453.5922 KRW, so the value of quotePrice value is 1453.5922.

  • Information about the payment:
    • transactionId: The transaction ID is 202504251940108001001880602907xxxxx, which is the same as the value of paymentId in the original payment.
    • transactionAmountValue: The transaction amount is 300 (KRW), which corresponds to 0.21 (USD).
    • feeAmountValue: The processing fee charged by the acquirer is -0.01 (USD).
    • settlementAmountValue: The net settlement amount, which is the transaction amount minus fees. In this example, the value of this parameter is the value of transactionAmountValue minus the value of feeAmountValue, which is 0.20 (USD).

In this example, the second transaction on April 23, 2025 was made in HKD and needs to be settled in USD, so the value of quoteCurrencyPair is USD/HKD. The exchange rate was 1 USD = 7.7988 HKD, so the value of quotePrice value is 7.7988.

  • Information about the refund:
    • transactionId: The transaction ID is 202504231940108013001886002681xxxxx, which is the same as the value of refundId in the original refund.
    • transactionAmountValue: The transaction amount is -0.6 (HKD), which corresponds to -0.08 (USD). That is, the refund amount is 0.08 (USD).
    • settlementAmountValue: The net settlement amount, which is the transaction amount minus fees. In this example, the handling fee charged for the original payment is not returned in the refund, so the net settlement amount is -0.08 (USD).

Sample 2 (No transaction)

copy
settlementBatchId,customerId,acquirer,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,paymentMethodType,pspName,transactionType,paymentTime,settlementTime,productCode,transactionAmountValue,transactionCurrency,settlementAmountValue,settlementCurrency,quoteCurrencyPair,quotePrice,feeAmountValue,feeCurrency,originalTransactionRequestId,acquirerTransactionType,acquirerCustomerId,acquirerBatchId,cardBrand
<END>,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,

📎Settlement details 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 APO technical support to configure it in the SFTP server.