Transaction Detail Report

Overview

Transaction Detail Reports that are provided by Alipay+ to Mobile Payment Partners (MPPs) includes all transaction details in a clearing cycle. The Transaction Detail Report is provided in a file format, and is generated with a Transaction Summary Report of the clearing cycle.

File location and naming convention

The Transaction Detail Report file is a text file in the UTF-8 encoding. By default, this file is saved in the directory /v1/settlements/clearing/<participantId>/<date>, and the default file name is transactionItems_<participantId>_<settlementCurrency>_<clearingBatchId>_<participantAgreementId>_<seq>.csv, where:

participantId: the unique ID that Alipay+ assigns to the MPP. The field identifies the receiver of the file.
clearingBatchId: clearing cycle index, used to indicate a unqiue clearing cycle.
settlementCurrency: the currency that is used in settlement, as agreed in the contract.
participantAgreementId: the unique ID that is assigned by Alipay+ to identify a settlement agreement between Alipay+ and the MPP. The ID represents the fund flow when MPP performs settlement to Alipay+.
seq: the sequence number that is in the range 000-999. The field is used when multiple files exist in the clearing cycle. The MPP and Alipay+ can determine the time when all records are available in SLA.

Report structure

The Transaction Detail Report consists of two parts:

Summary section, which displays the summary information about the transactions, for example, the total number of transactions and net total amount.
Detail section, which displays the transaction details, for example, transaction data details.

If no transaction exists in a clearing cycle, the Transaction Detail Report is still generated with the Transaction Summary Report, with 0 total count, 0 total amount, and no transaction details.

Structure

Summary section

No.	Field	Description
1	totalCount	Required String Total number of items in the clearing details files such as transaction items file and fees items file.
2	fundDirection	Required String Fund direction. Valid values are: `CREDIT`: specifies the fund direction that is from Alipay+ to the MPP. `DEBIT`: specifies the fund direction that is from the MPP to Alipay+.
3	settlementCurrency	Required String (3) The currency of the net settlement amount. The value is specified by using the three-character ISO 4217 currency code.
4	netSettlementAmountValue	Required String (16) The net settlement amount. The value is provided in the smallest unit of the corresponding currency.
5	transactionCurrency	Optional String (3) The currency of net transaction amount. The value is specified by using the three-character ISO 4217 currency code. Note: This field is empty when no transaction occurs in the clearing cycle or multiple transaction currencies are involved in the clearing cycle.
6	netTransactionAmountValue	Optional String (16) Net transaction amount. The value is provided in the smallest unit of the corresponding currency. Note: This field is empty when no transaction occurs in the clearing cycle or multiple transaction currencies are involved in the clearing cycle.
7	extendInfo	Optional String (2048) Extended information.

Detail section

No.	Field	Description
1	clearingBatchId	Required String (32) The unique ID that is assigned by Alipay+ to identify a clearing cycle.
2	participantId	Required String (64) The unique ID that is assigned by Alipay+ to identify an MPP.
3	counterParticipantId	Required String (64) The unique ID that is assigned by Alipay+ to identify an Acquiring Partner.
4	transactionRequestId	Required String (64) The unique ID that is assigned by Alipay+ to identify a transaction. For a payment, the value of this field is identical to that of paymentRequestId. For a refund, the value of this field is identical to that of refundRequestId.
5	originalTransactionRequestId	Optional String (64) An identifier for the original transaction. If the value of the transactionType field is `REFUND`, this field is identical to that of paymentRequestId. If the value of the transactionType field is `PAYMENT`, this field is empty.
6	transactionType	Required String Transaction type. Valid values are: `PAYMENT`: Payment `REFUND`: Refund
7	transactionTime	Required Datetime The date and time when the transaction reaches a final state of success or failure. The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:30".
8	fundDirection	Required String Fund direction. Valid values are: `CREDIT`: specifies the fund direction that is from Alipay+ to MPP. `DEBIT`: specifies the fund direction that is from MPP to Alipay+.
9	settlementCurrency	Required String (3) The currency of settlement amount. The value is specified by using the three-character ISO 4217 currency code.
10	settlementAmountValue	Required String (16) The settlement amount. The value is provided in the smallest unit of the corresponding currency. Notes: When the settlement currency is the same as the transaction currency, settlementAmountValue equals to transactionAmountValue. When the currencies are different, settlementAmountValue is calculated based on the exchange rate agreed in the contract.
11	transactionCurrency	Required String (3) The currency of the transaction amount. The value is specified by using the three-character ISO 4217 currency code.
12	transactionAmountValue	Required String (16) Transaction amount. The value is provided in the smallest unit of the corresponding currency.
13	feeDirection	Required String Fee direction. Valid values are: `CREDIT`: specifies the fund direction that is from Alipay+ to MPP. `DEBIT`: specifies the fund direction that is from MPP to Alipay+.
14	feeCurrency	Optional String (3) The currency of the net fee amount. The value is specified by using the three-character ISO 4217 currency code, and the same as the value of transactionCurrency.
15	netFeeAmountValue	Optional String (16) The net fee amount of all the fees charged for the transaction. The value is provided in the smallest unit of the corresponding currency.
16	feeSettlementCurrency	Optional String (3) The currency of net fee settlement amount. The value is specified by using the three-character ISO 4217 currency code.
17	netFeeSettlementAmountValue	Optional String (16) The net fee settlement amount of all the clearing fees charged for the transaction.
18	extendInfo	Optional String (2048) Extended information.

Sample

Use case 1

The following sample assumes that the MPP with an ID of 102218800000000**** has 2 transactions on December 25, 2018, and then Alipay+ provides a Transaction Detail Report to the MPP on December 26, 2018. In the sample, the user pays in KRW, and the MPP settles in USD.

See the following section for details:

Summary section: the MPP gets a settlement fund of 7.5 USD in total, as a result of 2 transactions that net 90 KRW in total.
Detail section:

1 payment is made in 180 KRW, which leads to 15 USD in the settlement amount, and 0.5 USD in the fee settlement amount for the MPP.
1 refund is made in 90 KRW, which leads to -7.5 USD in the settlement amount, and -0.25 USD in the fee settlement amount for the MPP.

Note: As the fee is calculated according to the settlement currency and settlement amount, the fields of feeCurrency and netFeeAmountValue in the detail section are empty.

copy

totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
2,DEBIT,USD,750,KRW,9000,
clearingBatchId,participantId,counterParticipantId,transactionRequestId,originalTransactionRequestId,transactionType,transactionTime,fundDirection,settlementCurrency,settlementAmountValue,transactionCurrency,transactionAmountValue,feeDirection,feeCurrency,netFeeAmountValue,feeSettlementCurrency,netFeeSettlementAmountValue,extendInfo
201812261102104****,102218800000000****,102218800000000****,10277574507****,,PAYMENT,2018-12-25T10:00:00+08:30,DEBIT,USD,1500,KRW,18000,CREDIT,,,USD,50,
201812261102104****,102218800000000****,102218800000000****,10277574507****,10277574507****,REFUND,2018-12-25T10:00:00+08:30,CREDIT,USD,750,KRW,9000,DEBIT,,,USD,25,

Use case 2

The following sample assumes that the MPP with an ID of 102xxxxxxxxxxxx0001 has no transactions on December 25, 2018. Alipay+ provides a Transaction Detail Report to the MPP on December 26, 2018.

copy

totalCount,fundDirection,settlementCurrency,netSettlementAmountValue,transactionCurrency,netTransactionAmountValue,extendInfo
0,DEBIT,USD,0,,,
clearingBatchId,participantId,counterParticipantId,transactionRequestId,originalTransactionRequestId,transactionType,transactionTime,fundDirection,settlementCurrency,settlementAmountValue,transactionCurrency,transactionAmountValue,feeDirection,feeCurrency,netFeeAmountValue,feeSettlementCurrency,netFeeSettlementAmountValue,extendInfo