API Reference
Report Header Descriptions
1. Settlement Report Header (Including Cycle Settlement Reports)
| Header Field | Field Type | Field Description |
|---|---|---|
VANhistoryID | String | Unique identifier for settlement records |
CardlogID | String | Card record ID, encrypted card number |
ProductCode | String | Card type, product code of the card |
TransID | String | Card record number (short card number) |
ActivityType | String | Transaction type, Refund - Refund, Purchase - Purchase, Rebate - Rebate, Chargeback - Chargeback, ChargebackFee - Chargeback fee |
IssuedToECN | String | Customer number |
VAN | String | Card number |
TransDate | String | Posting date, prior to cut-off, format yyyy-MM-dd |
TransTime | String | Posting time, settlement completion time, format yyyy-MM-dd HH:mm:ss |
TransCurr | String | Posting currency, card posting currency, e.g., USD, EUR, HKD |
TransAmt | String | Posting amount, card posting amount (transaction amount converted to card base currency) |
POSAmt | String | Transaction amount |
POSCurr | String | Transaction currency |
ReconciliationAmount | String | Settlement amount |
ReconciliationCurrency | String | Settlement currency |
RequestedDate | String | Card issuance date, format yyyy-MM-dd |
RequestedTime | String | Card issuance time, format yyyy-MM-dd HH:mm:ss |
LocalTime | String | Transaction time (local transaction time), format yyyy-MM-dd HH:mm:ss |
AuthTime | String | Authorization time |
MinAmt | String | Minimum authorization amount for the card |
VANAmt | String | Total issuance amount for the card |
MaxAmt | String | Maximum authorization amount for the card |
ActivationDate | String | Card activation date, format yyyy-MM-dd |
AuthAmt | String | Authorization amount |
AuthCurr | String | Authorization currency |
AuthCode | String | Authorization code |
ValidUntil | String | Card expiration date |
MerchID | String | MID, Merchant ID |
MerchCategoryCode | String | MCC, Merchant Category Code |
MerchCategoryName | String | MCC Name, Merchant Category Name |
MerchName | String | Merchant name |
MerchAddress | String | Merchant address |
MerchCity | String | Merchant city |
MerchState | String | Merchant state |
MerchPostCode | String | Merchant postal code |
MerchCountry | String | Merchant country |
CrossBoardType | String | Cross-border type, international - International, domestic - Domestic |
UserReference1 | String | Reserved field 1 |
UserReference2 | String | Reserved field 2 |
UserReference3 | String | Reserved field 3 |
UserReference4 | String | Reserved field 4 |
UserReference5 | String | Reserved field 5 |
UserReference6 | String | Reserved field 6 |
UserReference7 | String | Reserved field 7 |
UserReference8 | String | Reserved field 8 |
NatOrNot | String | Whether it is a Nat transaction, yes - Yes, no - No |
OrderId | String | Unique transaction ID, same as the OrderId in the authorization report |
2. Authorization Report Header
| Header Field | Field Type | Field Description |
|---|---|---|
CardlogID | String | Card record ID, encrypted card number |
ProductCode | String | Card type |
TransID | String | Card record number (short card number) |
Status | String | Card status |
IssuedToECN | String | Customer number |
CardType | String | Card type |
MerchantCategory | String | Merchant category |
VAN | String | Card number |
TransactionProfileCode | String | Transaction code, 6810 - Purchase authorization, 6510 - Refund authorization, 6930 - Purchase authorization reversal, 6940 - Refund authorization reversal, 6820 - Authorization inquiry |
TransactionProfileType | String | Transaction type, Authorization (Purchase) - Purchase authorization, Authorization (Refund) - Refund authorization, Authorization Reversal (Purchase) - Purchase authorization reversal, Authorization Reversal (Refund) - Refund authorization reversal, Authorization Query - Authorization inquiry |
RequestedTime | String | Card issuance time, format yyyy-MM-dd HH:mm:ss |
ActivationDate | String | Activatable date, format yyyy-MM-dd |
ExpiryDate | String | Expiration date, format yyyy-MM-dd |
VANCurrency | String | Card issuance currency |
MinAmt | String | Minimum transaction amount |
MaxAmt | String | Maximum transaction amount |
AvailableBalance | String | Available balance |
AuthCount | String | Number of authorizations |
VANMode | String | Single-use/Multi-use card, Singleuse - Single-use card, Multiuse - Multi-use card |
VANhistoryID | String | Authorization serial number |
AuthStatus | String | Authorization status, success - Success, failure - Failure |
MsgType | String | Message type |
AuthCode | String | Authorization code |
TransTime | String | UTC8 time, format yyyy-MM-dd HH:mm:ss |
POSCurr | String | POS transaction currency |
POSAmt | String | POS transaction amount |
MerchID | String | MID |
MerchantName | String | Merchant name |
MerchantCity | String | Merchant city |
MerchantCountry | String | Merchant country |
CrossBoardType | String | Cross-border type, international - International, domestic - Domestic |
MerchCategoryCode | String | MCC |
MerchCategoryName | String | MCC Name |
UserReference1 | String | Reserved field 1 |
UserReference2 | String | Reserved field 2 |
UserReference3 | String | Reserved field 3 |
UserReference4 | String | Reserved field 4 |
UserReference5 | String | Reserved field 5 |
UserReference6 | String | Reserved field 6 |
UserReference7 | String | Reserved field 7 |
UserReference8 | String | Reserved field 8 |
Notes | String | N/A, generally empty |
OrderId | String | Transaction ID |
3. Card Issued Report Header
| Header Field | Field Type | Field Description |
|---|---|---|
VAN | String | Card number |
CardlogID | String | Encrypted card number |
ProductCode | String | Card type |
TransID | String | Card record number (short card number) |
RequestedDate | String | Card application date, format yyyy-MM-dd |
RequestedTime | String | Card application time, format yyyy-MM-dd HH:mm:ss |
VANCurrency | String | Card issuance currency |
VANAmt | String | Card issuance limit |
SettlementCurrency | String | Settlement currency |
ActivationDate | String | Activatable date, format yyyy-MM-dd |
ExpiryDate | String | Expiration date, format yyyy-MM-dd |
VANMode | String | Card mode, Singleuse - Single-use card, Multiuse - Multi-use card |
CloseRatio | String | Close ratio percentage |
MinAuthAmt | String | Minimum authorization amount |
MaxAuthAmt | String | Maximum authorization amount |
BookingNumber | String | Booking number |
UserName | String | Card issuance user |
4. Repayment Report Header
| Header Field | Field Type | Field Description |
|---|---|---|
VANhistoryID | String | Transaction detail ID |
IssuedToECN | String | Customer ID |
Account | String | Account type |
ActivityType | String | Repayment |
PMTAmount | String | Repayment amount |
PMTCurrency | String | Repayment currency |
TransDate | String | Repayment date |
TransTime | String | Repayment time |
5. Chargeback Report Header
| Header Field | Field Type | Field Description |
|---|---|---|
ECN | String | Customer ID |
TransID | String | Card record number (short card number) |
CardlogID | String | Card record ID |
ProductCode | String | Card type |
NATID | String | N/A, generally empty |
MerchantName/Location/MC | String | MCC |
VAN | String | Card number |
Amount | String | Amount |
VANCurrency | String | Card currency |
NetSettled | String | Settlement amount |
SettlementCurrency | String | Settlement currency |
PosAmount | String | Transaction amount |
PosCurrency | String | Transaction currency |
VANAvailableBalance | String | Card balance |
VANIssuedDate | String | Card issuance date, format yyyy-MM-dd |
1stPresentmentDate | String | First presentment date, format yyyy-MM-dd |
ActionType | String | Transaction type, Chargeback in transit - Chargeback in progress, Small Balance advances - Small balance advance, Chargeback Release to Ctrip - Chargeback release to TripLink, Chargeback Release to BU - Chargeback release to customer |
ActionDate | String | Date, format yyyy-MM-dd |
TransTime | String | Time, format yyyy-MM-dd HH:mm:ss |
ActionBy | String | UID |
ChargebackReason | String | N/A, generally empty |
Notes/Justification | String | N/A, generally empty |
DocumentationFee | String | N/A, generally empty |
MasterCardDocumentationFee | String | N/A, generally empty |
MasterCardDocumentationFee | String | N/A, generally empty |
6. VCC Charge Report Header
| Header Field | Field Type | Field Description |
|---|---|---|
Date | String | Date, format yyyy-MM-dd |
ClientID | String | Customer ID |
ClientName | String | Customer name |
Top_up_Amount | String | Recharge amount |
Top_up_Currency | String | Recharge currency |
7. Authorization Fee Report Header
| Header Field | Field Type | Field Description |
|---|---|---|
Date | String | Date, format yyyy-MM-dd |
ClientID | String | Customer ID |
ClientName | String | Customer name |
Auth_Fee | String | Authorization fee |
Auth_Fee_Curr | String | Authorization fee currency |
CardlogID | String | Card ID |
ProductCode | String | Product code |
TransID | String | Transaction ID |
VAN | String | Card number |
TransactionProfileCode | String | Authorization code |
TransactionProfileType | String | Authorization type |
AuthStatus | String | Authorization status |
MsgType | String | Message type |
AuthCode | String | Authorization code |
TransTime | String | Authorization time |
POSCurr | String | Authorization currency |
POSAmt | String | Authorization amount |
8. Fund Details Report Header
| Header Field | Field Type | Field Description |
|---|---|---|
Customer_id | String | Customer ID |
Event_time | String | Event time, format yyyy-MM-dd HH:mm:ss |
ActivityType | String | Transaction type |
VANhistoryID | String | Serial number, unique |
OrderID | String | Transaction ID |
SettlementState | String | Settlement status (Yes/No) |
TransactionCurrency | String | Transaction currency |
TransactionAmount | String | Transaction amount |
CardlogId | String | Encrypted card number |
VAN | String | Card number |
Currency | String | Currency |
Amount | String | Amount |
BeginBalanceAmount | String | Beginning balance |
EndBalanceAmount | String | Ending balance |
AuthCode | String | Authorization code |
9. Exchange Report Header
| Header Field | Field Type | Field Description |
|---|---|---|
CustomerId | String | Customer ID |
CardlogID | String | Encrypted card number |
VAN | String | Card number |
AuthCode | String | Authorization code |
TransTime | String | Authorization time, format yyyy-MM-dd |
POSCurr | String | Authorization currency |
POSAmt | String | Authorization amount |
QuotaId | String | Exchange rate inquiry ID |
QuotaIdRate | String | Exchange rate |
FXTime | String | FX time, format yyyy-MM-dd HH:mm:ss |
BuyCurr | String | Buy currency |
BuyAmt | String | Buy amount |
SellCurr | String | Sell currency |
SellAmt | String | Sell amount |
Rate | String | Exchange rate (actual transaction rate) |
10. Rebate Report
| Header Field | Field Type | Field Description |
|---|---|---|
CardlogID | String | Encrypted card number |
orderid | String | Order ID |
TransID | String | Record ID |
ActivityType | String | Transaction type |
VAN | String | Card number |
TransDate | String | Posting date, format yyyy-MM-dd |
TransTime | String | Posting time, format yyyy-MM-dd HH:mm:ss |
ReconciliationCurrency | String | Settlement currency |
ReconciliationAmount | String | Settlement amount |
product_code | String | Card type |
crossboard_type | String | Cross-border type, international - International, domestic - Domestic |
commission_rate | String | Rebate rate |
commission_mcc_group | String | MCC group |
channel | String | Channel |
MerchName | String | Merchant name |