Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

Transaction details report

The transaction details report provides a detailed record of successful transactions on T day and is generated on T+1 day. You can obtain this report through the SFTP server or Antom Merchant Portal.

Report details

The transaction 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 transaction details are represented by the corresponding values of the parameters.

The following table shows the parameters in the transaction details report and parameter descriptions:

Parameter

Description

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.

Specify this parameter when the transaction is settled by the non-Antom acquirer.

referenceMerchantId

OPTIONAL String (64)

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

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

referenceStoreId

OPTIONAL String (64)

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

transactionId

MANDATORY String (64)

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

  • When transactionType is PAYMENT, CANCEL, AUTHORIZATION or PAYMENT_REVERSAL, 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, the value of this parameter is identical to that of disputeId.

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.
  • When transactionType is PAYMENT_REVERSAL, the value of this parameter is identical to that of paymentId of the original payment.

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.

orderDescription

OPTIONAL String (256)

The description of the order.

The value of this parameter is identical to that of orderDescription of the original payment or authorization.

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:

  • 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.
  • RAPID_DISPUTE_RESOLUTION: indicates a dispute process with Rapid Dispute Resolution (RDR).
  • PAYMENT_REVERSAL: indicates the success of the payment.

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.

productCode

MANDATORY String

The type of payment product that is contracted between Antom 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, dollars for USD, and yen for JPY).

transactionCurrency

MANDATORY String (3)

The currency of transactionAmountValue, 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 (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 CARD.

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 CARD.

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 CARD, GRABPAY_MY, or GRABPAY_SG.

When the value of paymentMethodType is CARD, valid values are:

  • CREDIT: indicates a credit card payment.
  • DEBIT: indicates a debit card payment.

When the value of paymentMethodType is GRABPAY_MY or GRABPAY_SG, valid values are:

  • WALLETS: indicates a regular wallet payment using the wallet balance.
  • BNPL_POSTPAID: indicates a buy-now-pay-later payment, and the user pays the full amount.
  • BNPL_INSTALLMENT: indicates a buy-now-pay-later payment, and the user pays in installments.

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 transaction 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 Merchant Portal may not match the parameter order displayed in Table 1.

Report samples

The following samples show transaction 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. On December 26, 2018, Antom generated a transaction details report in CSV. The details of the report are as follows:

copy
customerId,acquirer,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,orderDescription,paymentMethodType,pspName,transactionType,paymentTime,productCode,transactionAmountValue,transactionCurrency,originalTransactionRequestId,installmentsNum,issuingCountry,cardBrand,funding
102218800000000****,,,,,201812251907410100000000011****,,20190326L64842300****,,,KAKAOPAY,KaKaoPay,PAYMENT,2018-12-25T10:00:00+08:30,AGREEMENT_PAYMENT,18000,KRW,,,,,
102218800000000****,,,,,201812251907410200000000004****,201812251907410100000000011****,20190326L64842300****,,,KAKAOPAY,KaKaoPay,REFUND,2018-12-25T10:00:00+08:30,AGREEMENT_PAYMENT,-9000,KRW,20190326L64842300****,,,,
<END>

📎Transaction details report-Sample 1.csv

In this sample, the key information about the payment and refund is as follows:

  • Payment information:
    • transactionId: The transaction ID is 201812251907410100000000011****, which is the same value as the paymentIdin the original payment.
    • transactionAmountValue: The transaction amount is 18000 (KRW), which is the same as the value of paymentAmount.value in the original payment.
  • Refund information:
    • transactionId: The transaction ID is 201812251907410200000000004****, which is the same value as the refundIdin the original payment.
    • transactionAmountValue: The transaction amount is 9000 (KRW), which is the same as the value of refundAmount.value in the original refund.
    • originalTransactionId: The original transaction ID is 201812251907410100000000011****, which is the same as the paymentId in the original payment request.

Sample 2 (No transaction)

There was no transaction on December 25, 2018. On December 26, 2018, Antom generated an empty CSV file containing only the parameter names and the end-of-file character as follows:

copy
customerId,acquirer,acquirerReferenceNo,referenceMerchantId,referenceStoreId,transactionId,originalTransactionId,transactionRequestId,referenceTransactionId,orderDescription,paymentMethodType,pspName,transactionType,paymentTime,productCode,transactionAmountValue,transactionCurrency,originalTransactionRequestId,issuingCountry,cardBrand,funding
<END>

📎Transaction details report-Sample 2.csv

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