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

Settlement Items

The settlement Items report is used by Alipay to provide merchants with settlement details in a settlement cycle.

Report path and name

The settlement details report is a text file with UTF-8 code and is uploaded to a specified directory in SFTP for merchants to download and use. The file storage path defaults to /v1/settlements/<merchantIdByAcquirer>/<settlementDate>/ plus report name. The report name differs for each settlement mode:

Settlement by multiple payment methods:

The report name is settlementItems_<settlementCurrency>_<settlementBatchId>_<seq>.csv.

Settlement by single payment method:

The report name is different for Alipay+ MPPs and other payment methods.

  • For Alipay+ MPPs:
    • When Alipay+ MPPs are settled together: settlementItems_CONNECTWALLET_<settlementCurrency>_<settlementBatchId>_<seq>.csv
    • When Alipay+ MPPs are settled individually: settlementItems_<pspName>_<settlementCurrency>_<settlementBatchId>_<seq>.csv
  • For other payment methods: settlementItems_<paymentMethodType>_<settlementCurrency>_<settlementBatchId>_<seq>.csv

Details about the variables in the report name:

    • merchantIdByAcquirer: the unique ID that is assigned by Alipay to identify a merchant.
    • settlementDate: the settlement date.
    • pspName: the name of the actual Alipay+ Mobile Payment Provider, such as GCash.
    • settlementCurrency: the agreed settlement currency, which is the same as the settlement currency in the file content.
    • settlementBatchId: the settlement batch code corresponds to the settlement batch number in the Summary Files.
    • seq: the document serial number.

Report fields

The Settlement Items report is divided into two parts: settlement details and file endings. The report ends with a symbol of <END>, which appears in the last line of the report as the file end flag. The settlement details are illustrated by several fields and the corresponding values. The following table shows the details of the fields that appear in the report body:

Field

Description

settlementBatchId

MANDATORY String (64)

The unique ID that is assigned by the acquirer to identify a settlement cycle, which corresponds to the settlement batch number in the summary file. If the acquirer does not assign settlementBatchId, Alipay 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-Alipay acquirer for the transaction.

Specify this parameter when the transaction is settled by the non-Alipay acquirer. If the acquirer is Alipay, the transaction ID is identical to transactionId.

referenceMerchantId

OPTIONAL String (64)

The unique ID of the merchant that directly provides services or goods to users, assigned by the corresponding merchant.

Note:

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

referenceStoreId

OPTIONAL String (64)

The unique ID of the store that belongs to the merchant, assigned by the corresponding merchant.

transactionId

MANDATORY String (64)

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

  • When transactionType is PAYMENT, CANCEL, or AUTHORIZATION, the value of this field is identical to that of paymentId.
  • When transactionType is CAPTURE, the value of this field is identical to that of captureId.
  • When transactionType is REFUND, the value of this field is identical to that of refundId.
  • When transactionType is DISPUTE, the value of this field is identical to that of disputeId.

originalTransactionId

OPTIONAL String (64)

An identifier for the original transaction.

  • When transactionType is PAYMENT, CANCEL, AUTHORIZATION, or VOID, the value of this field is empty.
  • When transactionType is REFUND, the value of this field is identical to paymentId of the original payment or authorization.
  • When transactionType is CAPTURE, the value of this field is identical to paymentId of the original authorization.
  • When transactionType is DISPUTE, the value of this field 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 field is identical to that of paymentRequestId for a payment, or to that of refundRequestId for a refund.

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 field is identical to that of referenceOrderId for a payment.

Note: When transactionType is CANCEL, CAPTURE, or DISPUTE, the value of this field is empty.

paymentMethodType

MANDATORY String (64)

Payment method type of the payment that is processed. Valid values are:

  • TRUEMONEY
  • ALIPAY_HK
  • TNG
  • ALIPAY_CN
  • GCASH
  • DANA
  • KAKAOPAY
  • RABBIT_LINE_PAY
  • BPI
  • BOOST
  • CONNECT_WALLET
  • IDEAL
  • GIROPAY
  • SOFORT
  • PAYU
  • P24
  • BLIK
  • EPS
  • BANCONTACT
  • PIX
  • AKULAKU_PAYLATER
  • BANKAPP_BANGKOKBANK
  • BANKTRANSFER_BANGKOKBANK
  • BANKTRANSFER_SIAMCOMMERICALBANK
  • BANKAPP_SIAMCOMMERICALBANK
  • BANKTRANSFER_BANKOFAYUDHYA
  • BANKAPP_BANKOFAYUDHYA
  • BANKTRANSFER_KRUNGTHAIBANK
  • BANKAPP_KRUNGTHAIBANK
  • ONLINEBANKING_KRUNGTHAIBANK
  • ONLINEBANKING_SIAMCOMMERICALBANK
  • ONLINEBANKING_BANGKOKBANK
  • ONLINEBANKING_BANKOFAYUDHYA
  • ONLINEBANKING_KASIKORNBANK
  • BANKTRANSFER_KASIKORNBANK
  • BANKTRANSFER_GOVERNMENTSAVINGSBANK
  • CARD
  • PAYPAY
  • PROMPTPAY
  • DOLFIN
  • GRABPAY_SG
  • PAYNOW
  • LINKAJA
  • OVO
  • GOPAY_ID
  • OCTOCLICKS
  • ONLINEBANKING_BNI
  • ONLINEBANKING_MANDIRI
  • ONLINEBANKING_BRI
  • ONLINEBANKING_BCA
  • BANKTRANSFER_MAYBANK
  • BANKTRANSFER_BNI
  • BANKTRANSFER_PERMATA
  • CIMBNIAGA
  • BANKTRANSFER_MANDIRI
  • BANKTRANSFER_BSI
  • ATMTRANSFER_ID

Note:

The value of this field needs to be the same as that of the paymentMethodType field in the original payment or authorization request for all other transaction types.

pspName

OPTIONAL String (64)

Name of Alipay+ Mobile Payment Provider, such as GCash.

Note:

The value of this field needs to be the same as that of the pspName field in the original payment or authorization request for all other transaction types.

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 for authorization.
  • DISPUTE: Indicates a dispute process.

paymentTime

MANDATORY String (64)

The date and time when the corresponding transaction reaches a final status of success or failure, 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 the payment product that is contracted between Alipay and the merchant. Valid values are:

  • AGREEMENT_PAYMENT: indicates the auto debit payment
  • IN_STORE_PAYMENT: indicates the in-store payment
  • CASHIER_PAYMENT: indicates the cashier payment

Note:

The value of this field needs to be the same as that of the productCode field in the original payment or authorization request for all other transaction types.

transactionAmountValue

MANDATORY String (16)

The transaction amount in the smallest unit of the corresponding currency.

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 the smallest unit of the corresponding currency.

When the acquirer is Hundsun, the value of this parameter may be skewed. For more details, see Sample 4.

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.

Note: This field 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.

Note: This field is empty when the settlement currency is the same as the transaction currency.

feeAmountValue

MANDATORY String (16)

The amount of the processing fee charged by the payment method for each transaction. The value of feeAmountValue is in the smallest unit of the corresponding currency.

When the acquirer is Hundsun, the value of this parameter may be skewed. For more details, see Sample 4.

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 the smallest unit of the corresponding currency.

When the acquirer is Hundsun, the value of this parameter may be skewed. For more details, see Sample 4.

taxFeeCurrency

OPTIONAL 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 that is charged for the payment processing services Alipay provided for each transaction. The value of processingFeeAmountValue is in the smallest unit of the corresponding currency.

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 and is in the smallest unit of the corresponding currency.

nonGuaranteeCouponCurrency

OPTIONAL String (3)

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

disputeHandlingFee

OPTIONAL String (16)

The amount of the dispute handling fee.

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 reverse fee that is charged by Alipay to the merchant.

This parameter is specified when the merchant does not agree with the dispute.

disputeReverseFeeCurrency

OPTIONAL String (3)

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 REFUND, CANCEL, or CAPTURE. Otherwise, the value of this parameter is empty.

installmentsNum

OPTIONAL String

Indicates the number of installment payments.

Report samples

Settlement for single payment method

Sample 1

On December 25, 2018, the merchant with an ID of 1022188000000000001 has two transactions, one for a payment and the other for a refund.

  • Information about the payment:
    • paymentId: 2018122519074101000000000112612, which is also the value of transactionId.
    • PaymentAmount: 18000 KRW (transactionAmountValue), and corresponds to a 14.50 USD for settlement (settlementAmountValue).
    • The fee paid by the merchant to Alipay for 600 KRW is settled for 0.50 USD.
  • Information about the refund:
    • refundId: 2018122519074102000000000041675, which is also the value of transactionId.
    • refundFromAmount: 9000 KRW (transactionAmountValue, and corresponds to 7.25 USD for settlement (settlementAmountValue).
    • The fee returned by Alipay to the merchant for 300 KRW is settled for 0.25 USD.

On December 27, 2018, a CSV file with the file name settlementItems_KaKaoPay_USD_2018122611021040123_000.csv is generated by Alipay, of which 2018122611021040123 is the code for the current settlement cycle.  In this case, the merchant customer ID is 1022188000000000001. The file path is /v1/settlements/1022188000000000001/20181227/settlementItems_KaKaoPay_USD_2018122611021040123_000.csv.

The settlement details are as follows:

copy
settlementBatchId,acquirer,customerId,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,paymentMethodType,pspName,transactionType,paymentTime,settlementTime,productCode,transactionAmountValue,transactionCurrency,settlementAmountValue,settlementCurrency,quoteCurrencyPair,quotePrice,feeAmountValue,feeCurrency,processingFeeAmountValue,processingFeeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,originalTransactionRequestId,disputeHandlingFee,disputeHandlingFeeCurrency,disputeReverseFee,disputeReverseFeeCurrency,installmentNum
2018122611021040123,Alipay_SG,1022188000000000001,,,,2018122519074101000000000112612,,20190326L648423000404,,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,,,,,,,,,,
2018122611021040123,Alipay_SG,1022188000000000001,,,,2018122519074102000000000041675,2018122519074101000000000112612,20190326L648423000404,,KAKAOPAY,KaKaoPay,REFUND,2018-12-25T10:00:00+08:30,2018-12-26T10:00:00+08:30,AGREEMENT_PAYMENT,-9000,KRW,-725,USD,USD/KRW,1200,25,USD,,,,,20190326L6484230004,,,,,
<END>

Sample 2

On December 25, 2018, the merchant with an ID of 1022188000000000001 has two transactions, one for a payment and the other for a refund.

  • Information about the payment:
    • paymentId: 2018122519074101000000000112612, which is also the value of transactionId.
    • PaymentAmount is 18000 KRW (transactionAmountValue), minus 1200 KRW non guaranteed coupon which is 1.00 USD, corresponding to the settlement of 13.50 USD (settlementAmountValue).
    • The fee paid by the merchant to Alipay for 600KRW is settled for 0.50 USD.
  • Information about the refund:
    • refundId: 2018122519074102000000000041675, which is also the value of transactionId.
    • refundFromAmount: 9000 KRW (transactionAmountValue), including 600 KRW non guaranteed coupon which is 0.50 USD, corresponds to 6.75 USD (settlementAmountValue) for settlement.
    • The fee returned by Alipay to the merchant for 300KRW is settled for 0.25USD.

On December 27, 2018, a CSV file with the file name settlementItems_KaKaoPay_USD_2018122611021040123_000.csv is generated by Alipay, of which 2018122611021040123 is the code for the current settlement cycle.

The settlement details are as follows:

copy
settlementBatchId,acquirer,customerId,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,paymentMethodType,pspName,transactionType,paymentTime,settlementTime,productCode,transactionAmountValue,transactionCurrency,settlementAmountValue,settlementCurrency,quoteCurrencyPair,quotePrice,feeAmountValue,feeCurrency,processingFeeAmountValue,processingFeeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,originalTransactionRequestId,disputeHandlingFee,disputeHandlingFeeCurrency,disputeReverseFee,disputeReverseFeeCurrency,installmentNum
2018122611021040123,Alipay_SG,1022188000000000001,,,,2018122519074101000000000112612,,20190326L648423000404,,KAKAOPAY,KaKaoPay,PAYMENT,2018-12-25T10:00:00+08:30,2018-12-25T10:00:00+08:30,AGREEMENT_PAYMENT,18000,KRW,1450,USD,USD/KRW,1200,-50,USD,,,,,,,,,,
2018122611021040123,Alipay_SG,1022188000000000001,,,,2018122519074102000000000041675,2018122519074101000000000112612,20190326L648423000404,,KAKAOPAY,KaKaoPay,REFUND,2018-12-25T10:00:00+08:30,2018-12-25T10:00:00+08:30,AGREEMENT_PAYMENT,-9000,KRW,-725,USD,USD/KRW,1200,25,USD,,,0,USD,20190326L6484230004,,,,,
<END>

Sample 3

Assume that the settlement is T+4 and no transaction exists on December 22, 2018. The settlement date is December 26, 2018. On December 26, 2018, an empty CSV file with the file name of settlementItems_KaKaoPay_USD_0000000000000000000_000.cs is generated by Alipay.

The settlement details are as follows:

copy
settlementBatchId,acquirer,customerId,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,paymentMethodType,pspName,transactionType,paymentTime,settlementTime,productCode,transactionAmountValue,transactionCurrency,settlementAmountValue,settlementCurrency,quoteCurrencyPair,quotePrice,feeAmountValue,feeCurrency,processingFeeAmountValue,processingFeeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,originalTransactionRequestId,disputeHandlingFee,disputeHandlingFeeCurrency,disputeReverseFee,disputeReverseFeeCurrency,installmentNum
<END>

Sample 4

When the acquirer is Hundsun, Alipay will calculate the settlement data of each transaction for merchants, because Hundsun only provides the total settlement data. The total settlement data calculated by Alipay and Hundsun may be different, so Alipay provides the error correction information about the amount calculation differences. For example:

  • If the total settlementAmountValue values calculated by Hundsun and Alipay are respectively 37164 and 37140, the error correction information for settlementAmountValue is 24.
  • If the total feeAmountValue values calculated by Hundsun and Alipay are respectively 760 and 760, the error correction information for feeAmountValue is 0.
  • If the total taxFeeAmountValue values calculated by Hundsun and Alipay are respectively 76 and 100, the error correction information for taxFeeAmountValue is -24.

Note:

  • The merchant settles with the final settlement amount of Hundsun.
  • The error correction information is on the second-to-last line of settlement files.

On October 17, 2022, a merchant has three transactions, two for payments and one for a refund. The merchant's acquirer is Hundsun. On the settlement date of October 19, 2022, a CSV file with the file name settlementItems_PAYPAY_JPY_2022101909031102123_000.csv is generated by Alipay.

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,taxFeeAmountValue,taxFeeCurrency,processingFeeAmountValue,processingFeeCurrency,nonGuaranteeCouponValue,nonGuaranteeCouponCurrency,originalTransactionRequestId
2022101909031102123,Oxxxx742,Hundsun,J1PP20221017123123457V58,OB0220912345,,20221017194010890100111970280854321,,amsdmpay_20221017_113919_811176,,PAYPAY,,PAYMENT,2022-10-17T11:39:21+08:00,2022-10-30T23:00:00+08:00,CASHIER_PAYMENT,,100,JPY,,96,JPY,,,4,JPY,0,JPY,,,,,
2022101909031102123,Oxxxx742,Hundsun,J1PF2022101717312345G10,OB0220912345,,20221017194010890100111800280898765,20221017194010890100111800280612356,amsdmrefund_20221017_163611_111293,amsdmpay_20221017_120214_060,PAYPAY,,REFUND,2022-10-17T16:36:12+08:00,2022-10-30T23:00:00+08:00,CASHIER_PAYMENT,,-100,JPY,,-96,JPY,,,-4,JPY,0,JPY,,,,,amsdmpay_20221017_120214_011160
2022101909031102123,Oxxxx742,Hundsun,J2PP20221017130212345d58,OB0220912345,,20221017194010890100111800280612345,,amsdmpay_20221017_120214_011160,,PAYPAY,,PAYMENT,2022-10-17T12:02:15+08:00,2022-10-30T23:00:00+08:00,CASHIER_PAYMENT,,100,JPY,,96,JPY,,,4,JPY,0,JPY,,,,,
2022101909031102123,Oxxxx742,Hundsun,default,default,default,default,default,default,default,default,default,default,2022-10-30T23:00:00+08:00,2022-10-30T23:00:00+08:00,default,0,JPY,0,JPY,,,0,,3,JPY,,,,,default
<END>