Settlement details report
The settlement detail 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 Portal.
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:
|
originalTransactionId | OPTIONAL String (64) An identifier for the original transaction.
|
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 |
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 |
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 Alipay+ Mobile Payment Provider, 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:
|
paymentTime | MANDATORY String (64) The date and time when the corresponding transaction reaches a final status of success, in the format of |
settlementTime | MANDATORY String (64) The date and time when the settlement file is generated, in the format of |
productCode | MANDATORY String The type of payment product that is contracted between APO and the merchant. Valid values are:
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, dollars for USD, and yen for JPY). 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, dollars for USD, and yen for JPY). When the acquirer is Hundsun and the value of summaryType is TOTAL, the value of this parameter is accurate. When the acquirer is Hundsun and the value of summaryType is other than TOTAL, the value of this parameter may be skewed. For more information about the error correction information, see Acquirer Hundsun. |
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. |
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). When the acquirer is Hundsun, the value of this parameter may be skewed. For more information about the error correction information, see Acquirer Hundsun and Sample 2. When the acquirer is 2C2P and the Interchange++ pricing model is used, the value of this parameter may represent the error correction information. For more information about error correction information, see Interchange++ pricing model and Sample 3. |
feeCurrency | MANDATORY String (3) The currency of feeAmountValue, specified by a 3-letter currency code as defined in ISO 4217. |
taxFeeAmountValue | OPTIONAL String (16) The tax fee amount in major units of the corresponding currency (For example, dollars for USD, and yen for JPY). When the acquirer is Hundsun, the value of this parameter may be skewed. For more information about the error correction information, see Acquirer Hundsun and Sample 2. |
taxFeeCurrency | OPTIONAL String (3) The currency of taxFeeAmountValue, specified by a 3-letter currency code as defined in ISO 4217. |
processingFeeCurrency | OPTIONAL String (3) The currency of processingFeeAmountValue. The value of processingFeeCurrency is specified by a 3-letter currency code as defined in ISO 4217. |
nonGuaranteeCouponValue | OPTIONAL String (16) 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). |
nonGuaranteeCouponCurrency | OPTIONAL String (3) The currency of nonGuaranteeCouponValue, specified by a 3-letter currency code as defined in ISO 4217. |
disputeHandlingFeeCurrency | OPTIONAL String (3) The currency of disputeHandlingFee. The value of this parameter is specified by a 3-letter currency code as defined in ISO 4217. |
disputeReverseFee | OPTIONAL String (16) The amount of the reverse fee that is charged by APO 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). This parameter is specified when the merchant does not agree with the dispute. |
disputeReverseFeeCurrency | The currency of disputeReverseFee. The value of this parameter is 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 |
installmentsNum | OPTIONAL String (8) Indicates the number of installment payments. |
issuingCountry | OPTIONAL String (2) The issuing country or region of the card. The parameter is a 2-letter country or region code that follows the ISO 3166 Country Codes standard. This parameter is specified when paymentMethodType is The value of this parameter is identical to that of issuingCountry in the original payment or authorization request. |
cardBrand | OPTIONAL String (256) The brand of the card. This parameter is specified when paymentMethodType is The value of this parameter is identical to that of cardBrand in the original payment or authorization request. |
funding | OPTIONAL String (20) The funding type of the payment method. This parameter is returned when the value of paymentMethodType is When the value of paymentMethodType is
When the value of paymentMethodType is
The value of this parameter is identical to that of funding 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 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 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:
settlementBatchId,acquirer,customerId,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,paymentMethodType,pspName,transactionType,paymentTime,settlementTime,productCode,transactionAmountValue,transactionCurrency,settlementAmountValue,settlementCurrency,quoteCurrencyPair,quotePrice,feeAmountValue,feeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,originalTransactionRequestId,installmentNum,issuingCountry,cardBrand,funding
201812261102104****,Alipay_SG,102218800000000****,,,,201812251907410100000000011****,,20190326L64842300****,,KAKAOPAY,KaKaoPay,PAYMENT,2018-12-25T10:00:00+08:30,2018-12-26T10:00:00+08:30,AGREEMENT_PAYMENT,18000,KRW,1450,USD,USD/KRW,1200,50,USD,,,,,,,
201812261102104****,Alipay_SG,102218800000000****,,,,201812251907410200000000004****,201812251907410100000000011****,20190326L64842300****,,KAKAOPAY,KaKaoPay,REFUND,2018-12-25T10:00:00+08:30,2018-12-26T10:00:00+08:30,AGREEMENT_PAYMENT,-9000,KRW,-750,USD,USD/KRW,1200,0,USD,,,20190326L648423****,,,,
<END>,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,
📎Settlement details report-Sample 1.csv
In this example, transactions made in KRW need to be settled in USD, so the value of quoteCurrencyPair is USD/KRW. The exchange rate was 1 USD = 1200.0000 KRW, so the value of quotePrice value is 1200.0000.
- Information about the payment:
- transactionId: The transaction ID is 201812251907410100000000011****, which is the same as the value of paymentId in the original payment.
- transactionAmountValue: The transaction amount is 18000 (KRW), which corresponds to 15.00 (USD).
- feeAmountValue: The processing fee charged by the acquirer is 0.50 (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 14.50 (USD).
- Information about the refund:
- transactionId: The transaction ID is 201812251907410200000000004****, which is the same as the value of refundId in the original refund.
- transactionAmountValue: The transaction amount is -9000 KRW, which corresponds to -7.50 (USD). That is, the refund amount is 7.5 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 -7.50 (USD).
Sample 2 (No transaction)
settlementBatchId,acquirer,customerId,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,paymentMethodType,pspName,transactionType,paymentTime,settlementTime,productCode,transactionAmountValue,transactionCurrency,settlementAmountValue,settlementCurrency,quoteCurrencyPair,quotePrice,feeAmountValue,feeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,originalTransactionRequestId,installmentNum,issuingCountry,cardBrand,funding
<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 Merchant Service technical support to configure it in the SFTP server.