Skip to main content

Transaction

The following interfaces apply to prepaid cards, whose balances are managed in the EastPay issuing system. If you want to manage the account balance and status in your own system, please provide the relevant interfaces to us, which mainly include the following APIs:

  • Account interface (debit transactions and credit transactions)
  • Account/fee adjustment interface / notification
  • Balance inquiry
  • Revocation / voiding
  • Status updated / notification

Balancelnquiry

This API is used to retrieve balance details of an account associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterOptional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterOptional
6Billing Currency RatebillRateTransaction Currency to Billing Currency RateString16,6Optional
7Fee AmountfeeAmountFee AmountString16,2Optional

LoadFund

This API is used to load a specific amount into a given account or card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

Withdraw

This API is used to withdraw a specific amount from ATM with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

TransferFund

This API is used to transfer funds between cards.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional
10Beneficiary Card NumberbeneCardNoBeneficiary Card NumberStringMaximum 19 charactersRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

Purchase

This API is used to deduct a specific amount of purchase from an account associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional
10Goods InformationgoodsInfoGoods InformationStringMaximum 256 charactersOptional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

Refund

This API is used to refund or void a purchase transaction associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional
10Original Transaction DateoriTranDateOriginal Transaction DateStringYYYYMMDDRequired
11Original Transaction ReferenceoriTranIdOriginal Transaction ReferenceStringMaximum 32 charactersRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

Reversal

This API is used to reverse the result of an action from an account associated with a given card. It supports the reversal of LoadFund, Withdraw, TransferFund and Purchase.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Original Transaction DateoriTranDateOriginal Transaction DateStringYYYYMMDDRequired
7Original Transaction ReferenceoriTranIdOriginal Transaction ReferenceStringMaximum 32 charactersRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

BlockFund

This API is used to hold a specific amount for pre-authorization transactions from an account associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional
10Description of ReasonreasonDescDescription of ReasonStringMaximum 256 charactersOptional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

UnblockFund

This API is used to fully/partially release a hold of a specific amount for pre-authorization transactions from an account associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional
10Description of ReasonreasonDescDescription of ReasonStringMaximum 256 charactersOptional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

ServiceCharge

This API is used to apply a service fee into an account associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional
10Description of ReasonreasonDescDescription of ReasonStringMaximum 256 charactersOptional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

Verification

This API is used to verify an account associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterOptional
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Optional
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

DebitAdjustment

This API is used to perform debit adjustment on an account associated with a given card for various reasons.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional
10Description of ReasonreasonDescDescription of ReasonStringMaximum 256 charactersOptional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

CreditAdjustment

This API is used to perform credit adjustment on an account associated with a given card for various reasons.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
2Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
3Merchant IdmerchantIdMerchant IdStringMaximum 15 charactersOptional
4Merchant NamemerchantNameMerchant NameStringMaximum 40 charactersOptional
5Merchant Category CodemccMerchant Category CodeStringMaximum 4 charactersOptional
6Transaction CurrencytranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
7Transaction AmounttranAmountTransaction AmountStringNumber(16,2)Required
8Bill CurrencybillCurrencyBill CurrencyStringMaximum 3 characterOptional
9Bill AmountbillAmountBill AmountStringNumber(16,2)Optional
10Description of ReasonreasonDescDescription of ReasonStringMaximum 256 charactersOptional

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Account BalanceacctBalanceAccount BalanceStringNumber(16,2)Conditional
2Available BalanceavaiBalanceAvailable BalanceStringNumber(16,2)Conditional
3Block BalanceblockBalanceBlock BalanceStringNumber(16,2)Conditional
4Account CurrencyaccCurrencyAccount CurrencyStringMaximum 3 characterRequired
5Fee AmountfeeAmountFee AmountString16,2Optional

TransactionHistory

This API is used to retrieve a list of transactions associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1CIF NumbercustomerIdCustomer unique IDStringMaximum 32 charactersConditional
2Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
3Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
4Start DatestartDateStart DateStringYYYYMMDDRequired
5End DateendDateEnd DateStringYYYYMMDDRequired
6Page SizepageSizePage SizeStringMaximum 2 characterRequired
7Page NumberpageNumPage NumberStringMaximum 8 characterRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Total RecordstotalRecordTotal RecordsStringMaximum 8 characterRequired
2Total PagestotalPageTotal PagesStringMaximum 8 characterRequired
3Record NumberrecordNumRecord NumberStringMaximum 8 characterRequired
4Record ListrecordListeach element is a complex element that includes the following sub-elements:
4.1sub-elements of each element in the listcardNumberCard NumberStringMaximum 19 characterRequired
4.2retrievalRefNoretrieval Reference NumberStringMaximum 12 charactersRequired
4.3approvalCodeTransaction Approval CodeStringMaximum 6 charactersOptionalYYYYMMDD
4.4tranIdTransaction Serial NumberStringMaximum 32 charactersRequiredHHMISS
4.5tranDateTransaction DateString8 charactersRequired
4.6tranTimeTransaction TimeString6 charactersRequired
4.7tranTypeTransaction Type
C-Cash Withdraw
D-Deposit
G-Purchase
H-Refund
String1 charactersRequired
4.8tranCodeTransaction CodeStringMaximum 10 charactersRequired
4.9tranNameTransaction DescriptionStringMaximum 60 charactersRequired
4.10merchantIdMerchant IdStringMaximum 15 charactersRequired
4.11merchantNameMerchant NameStringMaximum 40 charactersRequired
4.12tranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
4.13tranAmountTransaction AmountString16,2Required
4.14billCurrencyBill CurrencyStringMaximum 3 characterRequired
4.15billAmountBill AmountString16,2Required
4.16feeAmountFee AmountString16,2Required
4.17tranStatusCodeTransaction Status CodeStringMaximum 2 characterRequired
4.18tranStatusDescTransaction Status DescriptionStringMaximum 40 charactersRequired
4.19cardNumberCard NumberStringMaximum 19 characterRequired

AuthorizationHistory

This API is used to retrieve a list of authorizations associated with a given card.

Request:

Data ElementField NameDescriptionFormatLengthM/ORemark
1CIF NumbercustomerIdCustomer unique IDStringMaximum 32 charactersConditional
2Card Token NumbercardTokenCard Token NumberStringMaximum 19 charactersConditional
3Card NumbercardNumberCard NumberStringMaximum 19 characterConditional
4Start DatestartDateStart DateStringYYYYMMDDRequired
5End DateendDateEnd DateStringYYYYMMDDRequired
6Page SizepageSizePage SizeStringMaximum 2 characterRequired
7Page NumberpageNumPage NumberStringMaximum 8 characterRequired

Response:

Data ElementField NameDescriptionFormatLengthM/ORemark
1Total RecordstotalRecordTotal RecordsStringMaximum 8 characterRequired
2Total PagestotalPageTotal PagesStringMaximum 8 characterRequired
3Record NumberrecordNumRecord NumberStringMaximum 8 characterRequired
2Record ListrecordListeach element is a complex element that includes the following sub-elements:
2.1sub-elements of each element in the listcardNumberCard NumberStringMaximum 19 characterRequired
2.2retrievalRefNoretrieval Reference NumberStringMaximum 12 charactersRequired
2.3approvalCodeTransaction Approval CodeStringMaximum 6 charactersOptionalYYYYMMDD
2.4tranIdTransaction Serial NumberStringMaximum 32 charactersRequiredHHMISS
2.5tranDateTransaction DateString8 charactersRequired
2.6tranTimeTransaction TimeString6 charactersRequired
2.7tranTypeTransaction Type
C-Cash Withdraw
D-Deposit
G-Purchase
H-Refund
String1 charactersRequired
2.8tranCodeTransaction CodeStringMaximum 10 charactersRequired
2.9tranNameTransaction DescriptionStringMaximum 60 charactersRequired
2.10merchantIdMerchant IdStringMaximum 15 charactersRequired
2.11merchantNameMerchant NameStringMaximum 40 charactersRequired
2.12tranCurrencyTransaction CurrencyStringMaximum 3 characterRequired
2.13tranAmountTransaction AmountString16,2Required
2.14billCurrencyBill CurrencyStringMaximum 3 characterRequired
2.15billAmountBill AmountString16,2Required
2.16feeAmountFee AmountString16,2Required
2.17acctBalanceAccount BalanceString16,2Required
2.18tranStatusCodeTransaction Status CodeStringMaximum 2 characterRequired
2.19tranStatusDescTransaction Status DescriptionStringMaximum 40 charactersRequired