Alipay+Alipay+

Fee Report

Overview

Fee Report that is provided by Alipay+ to Mobile Payment Partners (MPPs) includes all fees in a clearing cycle. The Fee 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 Fee 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 default file name is feeItems_<participantId>_<settlementCurrency>_<clearingBatchId>_<participantAgreementId>_<seq>.csv, where:

  • participantId: the unique ID that Alipay+ assigns to the Mobile Payment Partner. 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 Mobile Payment Partner. The ID represents the fund flow when Mobile Payment Partner 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 Fee Report consists of two parts:

  • Summary section, which displays the summary information about fees, for example, the total number of fee items and the total amount of fees.
  • Detail section, which displays the fee details.

 

If no fee is to be settled, the fee summary information is represented with 0 total count, 0 total amount, and no fee details.

Structure

Summary section

No.

Field

Description

1

totalCount

Required String

Total number of items in the clearing Fee Report file.

2

feeDirection

Required String

Fee direction. Valid values are:

  • CREDIT: specifies the fund direction that is from Alipay+ to the Mobile Payment Partner.
  • DEBIT: specifies the fund direction that is from the Mobile Payment Partner to Alipay+.

3

feeSettlementCurrency

Required String (3)

The currency of the net fee settlement amount. The value is specified by using the three-character ISO 4217 currency code.

4

netFeeSettlementAmountValue

Required String (16)

The net fee settlement amount of all the clearing fees that are charged for the transaction.

5

feeCurrency

Optional String (3)

The currency of the net fee amount that is specified by the three-character ISO 4217 currency code. 

Note:

The field is empty when no fee details for the clearing cycle are generated, or when multiple billing currencies exist in the clearing cycle.

6

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. 

Note:

The field is empty when no fee details for the clearing cycle are generated, or when multiple billing currencies exist 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 Mobile Payment Partner.

3

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.

4

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.

5

transactionType

Required String

Transaction type. Valid values are:

  • PAYMENT: Payment
  • REFUND: Refund

6

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

7

transactionCurrency

Required String (3)

The currency of the transaction amount. The value is specified by using the three-character ISO 4217 currency code.

8

transactionAmountValue

Required String (16)

Transaction amount. The value is provided in the smallest unit of the corresponding currency.

9

feeId

Required String (64)

The unique ID that is assigned by Alipay+ to identify a fee.

10

feeType

Required String

Fee type. Valid values are:

  • INTERCHANGE_FEE: Interchange fee, also known as interpartner fee, the fee that the ACQP pays to the MPP for a transaction.
  • SERVICE_FEE: Service fee

11

feeDirection

Required String

Fee direction. Valid values are:

  • CREDIT: specifies the fund direction that is from Alipay+ to theMobile Payment Partner.
  • DEBIT: specifies the fund direction that is from the Mobile Payment Partner to Alipay+.

12

feeSettlementCurrency

Required String (3)

The currency of the fee settlement amount. The value is specified by using the three-character ISO 4217 currency code.

13

feeSettlementAmountValue

Required String (16)

The fee settlement amount of the transaction. The value is provided in the smallest unit of the corresponding currency.

Notes:

  • If the settlement currency agreed by the MPP is the same as the billing currency, the value of feeSettlementAmountValue equals to that of feeAmountValue.
  • If the two currencies are different, the value of feeSettlementAmountValue is calculated according to the agreed exchange rate.

14

feeCurrency

Required String (3)

The currency of the fee amount. The value is specified by using the three-character ISO 4217 currency code.

Note: The field is empty when no fee details for the clearing cycle are generated, or when multiple billing currencies exist in the clearing cycle.

15

feeAmountValue

Required String (16)

The fee amount of all the fees that are charged for the transaction. The value is provided in the smallest unit of the corresponding currency.

16

extendInfo

Optional String (2048)

Extended information

Sample

Use Case 1

The following sample assumes that the MPP with an ID of 102xxxxxxxxxxxx0001 has 2 transactions on December 25, 2018, which resulted in 4 fee items, and then Alipay+ provides a Fee Report to the MPP on December 26, 2018.

See the following section for details:

  • Summary section: the total fee amount for the MPP is 0.25 USD (3 KRW), as a result of 4 fee items.
  • Detail section:
  • 1 payment is made in 180 KRW, which leads to 0.5 USD (12 KRW) settlement fee amount as the service fee.
  • 1 payment is made in 180 KRW, which leads to -1 USD (-12 KRW) settlement fee amount as the interchange fee.
  • 1 refund is made in 90 KRW, which leads to 0.25 USD (3 KRW) settlement fee amount as the service fee.
  • 1 refund is made in 90 KRW, which leads to 0.5 USD (6 KRW) settlement fee amount as the interchange fee.

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

copy
totalCount,feeDirection,feeSettlementCurrency,netFeeSettlementAmountValue,feeCurrency,netFeeAmountValue,extendInfo
4,DEBIT,USD,25,,,
clearingBatchId,participantId,transactionRequestId,originalTransactionRequestId,transactionType,transactionTime,transactionCurrency,transactionAmountValue,feeId,feeType,feeDirection,feeSettlementCurrency,feeSettlementAmountValue,feeCurrency,feeAmountValue,extendInfo
201812261102104****,102218800000000****,10277574507****,,PAYMENT,2018-12-25T10:00:00+08:30,KRW,18000,2018122519074101000000000212031,SERVICE_FEE,DEBIT,USD,50,,,
201812261102104****,102218800000000****,10277574507****,,PAYMENT,2018-12-25T10:00:00+08:30,KRW,18000,2018122519074101000000000212032,INTERCHANGE_FEE,CREDIT,USD,100,,,
201812261102104****,102218800000000****,10277574507****,10277574507****,REFUND,2018-12-25T10:00:00+08:30,KRW,9000,201812251907410100000000021****,SERVICE_FEE,DEBIT,USD,25,,,
201812261102104****,102218800000000****,10277574507****,10277574507****,REFUND,2018-12-25T10:00:00+08:30,KRW,9000,201812251907410100000000021****,INTERCHANGE_FEE,DEBIT,USD,50,,,

 

Use case 2 

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

copy
totalCount,feeDirection,feeSettlementCurrency,netFeeSettlementAmountValue,feeCurrency,netFeeAmountValue,extendInfo
0,DEBIT,USD,0,,,
clearingBatchId,participantId,transactionRequestId,originalTransactionRequestId,transactionType,transactionTime,transactionCurrency,transactionAmountValue,feeId,feeType,feeDirection,feeSettlementCurrency,feeSettlementAmountValue,feeCurrency,feeAmountValue,extendInfo