Skip to main content

API Reference

Report Header Descriptions

1. Settlement Report Header (Including Cycle Settlement Reports)

Header FieldField TypeField Description
VANhistoryIDStringUnique identifier for settlement records
CardlogIDStringCard record ID, encrypted card number
ProductCodeStringCard type, product code of the card
TransIDStringCard record number (short card number)
ActivityTypeStringTransaction type, Refund - Refund, Purchase - Purchase, Rebate - Rebate, Chargeback - Chargeback, ChargebackFee - Chargeback fee
IssuedToECNStringCustomer number
VANStringCard number
TransDateStringPosting date, prior to cut-off, format yyyy-MM-dd
TransTimeStringPosting time, settlement completion time, format yyyy-MM-dd HH:mm:ss
TransCurrStringPosting currency, card posting currency, e.g., USD, EUR, HKD
TransAmtStringPosting amount, card posting amount (transaction amount converted to card base currency)
POSAmtStringTransaction amount
POSCurrStringTransaction currency
ReconciliationAmountStringSettlement amount
ReconciliationCurrencyStringSettlement currency
RequestedDateStringCard issuance date, format yyyy-MM-dd
RequestedTimeStringCard issuance time, format yyyy-MM-dd HH:mm:ss
LocalTimeStringTransaction time (local transaction time), format yyyy-MM-dd HH:mm:ss
AuthTimeStringAuthorization time
MinAmtStringMinimum authorization amount for the card
VANAmtStringTotal issuance amount for the card
MaxAmtStringMaximum authorization amount for the card
ActivationDateStringCard activation date, format yyyy-MM-dd
AuthAmtStringAuthorization amount
AuthCurrStringAuthorization currency
AuthCodeStringAuthorization code
ValidUntilStringCard expiration date
MerchIDStringMID, Merchant ID
MerchCategoryCodeStringMCC, Merchant Category Code
MerchCategoryNameStringMCC Name, Merchant Category Name
MerchNameStringMerchant name
MerchAddressStringMerchant address
MerchCityStringMerchant city
MerchStateStringMerchant state
MerchPostCodeStringMerchant postal code
MerchCountryStringMerchant country
CrossBoardTypeStringCross-border type, international - International, domestic - Domestic
UserReference1StringReserved field 1
UserReference2StringReserved field 2
UserReference3StringReserved field 3
UserReference4StringReserved field 4
UserReference5StringReserved field 5
UserReference6StringReserved field 6
UserReference7StringReserved field 7
UserReference8StringReserved field 8
NatOrNotStringWhether it is a Nat transaction, yes - Yes, no - No
OrderIdStringUnique transaction ID, same as the OrderId in the authorization report

2. Authorization Report Header

Header FieldField TypeField Description
CardlogIDStringCard record ID, encrypted card number
ProductCodeStringCard type
TransIDStringCard record number (short card number)
StatusStringCard status
IssuedToECNStringCustomer number
CardTypeStringCard type
MerchantCategoryStringMerchant category
VANStringCard number
TransactionProfileCodeStringTransaction code, 6810 - Purchase authorization, 6510 - Refund authorization, 6930 - Purchase authorization reversal, 6940 - Refund authorization reversal, 6820 - Authorization inquiry
TransactionProfileTypeStringTransaction 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
RequestedTimeStringCard issuance time, format yyyy-MM-dd HH:mm:ss
ActivationDateStringActivatable date, format yyyy-MM-dd
ExpiryDateStringExpiration date, format yyyy-MM-dd
VANCurrencyStringCard issuance currency
MinAmtStringMinimum transaction amount
MaxAmtStringMaximum transaction amount
AvailableBalanceStringAvailable balance
AuthCountStringNumber of authorizations
VANModeStringSingle-use/Multi-use card, Singleuse - Single-use card, Multiuse - Multi-use card
VANhistoryIDStringAuthorization serial number
AuthStatusStringAuthorization status, success - Success, failure - Failure
MsgTypeStringMessage type
AuthCodeStringAuthorization code
TransTimeStringUTC8 time, format yyyy-MM-dd HH:mm:ss
POSCurrStringPOS transaction currency
POSAmtStringPOS transaction amount
MerchIDStringMID
MerchantNameStringMerchant name
MerchantCityStringMerchant city
MerchantCountryStringMerchant country
CrossBoardTypeStringCross-border type, international - International, domestic - Domestic
MerchCategoryCodeStringMCC
MerchCategoryNameStringMCC Name
UserReference1StringReserved field 1
UserReference2StringReserved field 2
UserReference3StringReserved field 3
UserReference4StringReserved field 4
UserReference5StringReserved field 5
UserReference6StringReserved field 6
UserReference7StringReserved field 7
UserReference8StringReserved field 8
NotesStringN/A, generally empty
OrderIdStringTransaction ID

3. Card Issued Report Header

Header FieldField TypeField Description
VANStringCard number
CardlogIDStringEncrypted card number
ProductCodeStringCard type
TransIDStringCard record number (short card number)
RequestedDateStringCard application date, format yyyy-MM-dd
RequestedTimeStringCard application time, format yyyy-MM-dd HH:mm:ss
VANCurrencyStringCard issuance currency
VANAmtStringCard issuance limit
SettlementCurrencyStringSettlement currency
ActivationDateStringActivatable date, format yyyy-MM-dd
ExpiryDateStringExpiration date, format yyyy-MM-dd
VANModeStringCard mode, Singleuse - Single-use card, Multiuse - Multi-use card
CloseRatioStringClose ratio percentage
MinAuthAmtStringMinimum authorization amount
MaxAuthAmtStringMaximum authorization amount
BookingNumberStringBooking number
UserNameStringCard issuance user

4. Repayment Report Header

Header FieldField TypeField Description
VANhistoryIDStringTransaction detail ID
IssuedToECNStringCustomer ID
AccountStringAccount type
ActivityTypeStringRepayment
PMTAmountStringRepayment amount
PMTCurrencyStringRepayment currency
TransDateStringRepayment date
TransTimeStringRepayment time

5. Chargeback Report Header

Header FieldField TypeField Description
ECNStringCustomer ID
TransIDStringCard record number (short card number)
CardlogIDStringCard record ID
ProductCodeStringCard type
NATIDStringN/A, generally empty
MerchantName/Location/MCStringMCC
VANStringCard number
AmountStringAmount
VANCurrencyStringCard currency
NetSettledStringSettlement amount
SettlementCurrencyStringSettlement currency
PosAmountStringTransaction amount
PosCurrencyStringTransaction currency
VANAvailableBalanceStringCard balance
VANIssuedDateStringCard issuance date, format yyyy-MM-dd
1stPresentmentDateStringFirst presentment date, format yyyy-MM-dd
ActionTypeStringTransaction 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
ActionDateStringDate, format yyyy-MM-dd
TransTimeStringTime, format yyyy-MM-dd HH:mm:ss
ActionByStringUID
ChargebackReasonStringN/A, generally empty
Notes/JustificationStringN/A, generally empty
DocumentationFeeStringN/A, generally empty
MasterCardDocumentationFeeStringN/A, generally empty
MasterCardDocumentationFeeStringN/A, generally empty

6. VCC Charge Report Header

Header FieldField TypeField Description
DateStringDate, format yyyy-MM-dd
ClientIDStringCustomer ID
ClientNameStringCustomer name
Top_up_AmountStringRecharge amount
Top_up_CurrencyStringRecharge currency

7. Authorization Fee Report Header

Header FieldField TypeField Description
DateStringDate, format yyyy-MM-dd
ClientIDStringCustomer ID
ClientNameStringCustomer name
Auth_FeeStringAuthorization fee
Auth_Fee_CurrStringAuthorization fee currency
CardlogIDStringCard ID
ProductCodeStringProduct code
TransIDStringTransaction ID
VANStringCard number
TransactionProfileCodeStringAuthorization code
TransactionProfileTypeStringAuthorization type
AuthStatusStringAuthorization status
MsgTypeStringMessage type
AuthCodeStringAuthorization code
TransTimeStringAuthorization time
POSCurrStringAuthorization currency
POSAmtStringAuthorization amount

8. Fund Details Report Header

Header FieldField TypeField Description
Customer_idStringCustomer ID
Event_timeStringEvent time, format yyyy-MM-dd HH:mm:ss
ActivityTypeStringTransaction type
VANhistoryIDStringSerial number, unique
OrderIDStringTransaction ID
SettlementStateStringSettlement status (Yes/No)
TransactionCurrencyStringTransaction currency
TransactionAmountStringTransaction amount
CardlogIdStringEncrypted card number
VANStringCard number
CurrencyStringCurrency
AmountStringAmount
BeginBalanceAmountStringBeginning balance
EndBalanceAmountStringEnding balance
AuthCodeStringAuthorization code

9. Exchange Report Header

Header FieldField TypeField Description
CustomerIdStringCustomer ID
CardlogIDStringEncrypted card number
VANStringCard number
AuthCodeStringAuthorization code
TransTimeStringAuthorization time, format yyyy-MM-dd
POSCurrStringAuthorization currency
POSAmtStringAuthorization amount
QuotaIdStringExchange rate inquiry ID
QuotaIdRateStringExchange rate
FXTimeStringFX time, format yyyy-MM-dd HH:mm:ss
BuyCurrStringBuy currency
BuyAmtStringBuy amount
SellCurrStringSell currency
SellAmtStringSell amount
RateStringExchange rate (actual transaction rate)

10. Rebate Report

Header FieldField TypeField Description
CardlogIDStringEncrypted card number
orderidStringOrder ID
TransIDStringRecord ID
ActivityTypeStringTransaction type
VANStringCard number
TransDateStringPosting date, format yyyy-MM-dd
TransTimeStringPosting time, format yyyy-MM-dd HH:mm:ss
ReconciliationCurrencyStringSettlement currency
ReconciliationAmountStringSettlement amount
product_codeStringCard type
crossboard_typeStringCross-border type, international - International, domestic - Domestic
commission_rateStringRebate rate
commission_mcc_groupStringMCC group
channelStringChannel
MerchNameStringMerchant name