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 Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Optional
6	Billing Currency Rate	billRate	Transaction Currency to Billing Currency Rate	String	16,6	Optional
7	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

LoadFund

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

Withdraw

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

TransferFund

This API is used to transfer funds between cards.

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional
9	Beneficiary Card Number	beneCardNo	Beneficiary Card Number	String	Maximum 19 characters	Required

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

Purchase

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional
9	Goods Information	goodsInfo	Goods Information	String	Maximum 256 characters	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

Refund

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional
9	Original Transaction Date	oriTranDate	Original Transaction Date	String	YYYYMMDD	Required
10	Original Transaction Reference	oriTranId	Original Transaction Reference	String	Maximum 32 characters	Required

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

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 Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Original Transaction Date	oriTranDate	Original Transaction Date	String	YYYYMMDD	Required
6	Original Transaction Reference	oriTranId	Original Transaction Reference	String	Maximum 32 characters	Required

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

BlockFund

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional
9	Description of Reason	reasonDesc	Description of Reason	String	Maximum 256 characters	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

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 Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional
9	Description of Reason	reasonDesc	Description of Reason	String	Maximum 256 characters	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

ServiceCharge

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional
9	Description of Reason	reasonDesc	Description of Reason	String	Maximum 256 characters	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

Verification

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Optional
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Optional
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

DebitAdjustment

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional
9	Description of Reason	reasonDesc	Description of Reason	String	Maximum 256 characters	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

CreditAdjustment

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
2	Merchant Id	merchantId	Merchant Id	String	Maximum 15 characters	Optional
3	Merchant Name	merchantName	Merchant Name	String	Maximum 40 characters	Optional
4	Merchant Category Code	mcc	Merchant Category Code	String	Maximum 4 characters	Optional
5	Transaction Currency	tranCurrency	Transaction Currency	String	Maximum 3 character	Required
6	Transaction Amount	tranAmount	Transaction Amount	String	Number(16,2)	Required
7	Bill Currency	billCurrency	Bill Currency	String	Maximum 3 character	Optional
8	Bill Amount	billAmount	Bill Amount	String	Number(16,2)	Optional
9	Description of Reason	reasonDesc	Description of Reason	String	Maximum 256 characters	Optional

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Account Balance	acctBalance	Account Balance	String	Number(16,2)	Conditional
2	Available Balance	avaiBalance	Available Balance	String	Number(16,2)	Conditional
3	Block Balance	blockBalance	Block Balance	String	Number(16,2)	Conditional
4	Account Currency	accCurrency	Account Currency	String	Maximum 3 character	Required
5	Fee Amount	feeAmount	Fee Amount	String	16,2	Optional

TransactionHistory

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	CIF Number	customerId	Customer unique ID	String	Maximum 32 characters	Conditional
2	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
3	Start Date	startDate	Start Date	String	YYYYMMDD	Required
4	End Date	endDate	End Date	String	YYYYMMDD	Required
5	Page Size	pageSize	Page Size	String	Maximum 2 character	Required
6	Page Number	pageNum	Page Number	String	Maximum 8 character	Required

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Total Records	totalRecord	Total Records	String	Maximum 8 character	Required
2	Total Pages	totalPage	Total Pages	String	Maximum 8 character	Required
3	Record Number	recordNum	Record Number	String	Maximum 8 character	Required
4	Record List	recordList	each element is a complex element that includes the following sub-elements:
4.1	sub-elements of each element in the list	cardNumber	Card Number	String	Maximum 19 character	Optional
4.2		retrievalRefNo	retrieval Reference Number	String	Maximum 12 characters	Required
4.3		approvalCode	Transaction Approval Code	String	Maximum 6 characters	Optional	YYYYMMDD
4.4		tranId	Transaction Serial Number	String	Maximum 32 characters	Required	HHMISS
4.5		tranDate	Transaction Date	String	8 characters	Required
4.6		tranTime	Transaction Time	String	6 characters	Required
4.7		tranType	Transaction Type C-Cash Withdraw D-Deposit G-Purchase H-Refund	String	1 characters	Required
4.8		tranCode	Transaction Code	String	Maximum 10 characters	Required
4.9		tranName	Transaction Description	String	Maximum 60 characters	Required
4.10		merchantId	Merchant Id	String	Maximum 15 characters	Required
4.11		merchantName	Merchant Name	String	Maximum 40 characters	Required
4.12		tranCurrency	Transaction Currency	String	Maximum 3 character	Required
4.13		tranAmount	Transaction Amount	String	16,2	Required
4.14		billCurrency	Bill Currency	String	Maximum 3 character	Required
4.15		billAmount	Bill Amount	String	16,2	Required
4.16		feeAmount	Fee Amount	String	16,2	Required
4.17		tranStatusCode	Transaction Status Code	String	Maximum 2 character	Required
4.18		tranStatusDesc	Transaction Status Description	String	Maximum 40 characters	Required
4.19		cardToken	Card Token Number	String	Maximum 19 character	Optional

AuthorizationHistory

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

Request:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	CIF Number	customerId	Customer unique ID	String	Maximum 32 characters	Conditional
2	Card Token Number	cardToken	Card Token Number	String	Maximum 19 characters	Conditional
3	Start Date	startDate	Start Date	String	YYYYMMDD	Required
4	End Date	endDate	End Date	String	YYYYMMDD	Required
5	Page Size	pageSize	Page Size	String	Maximum 2 character	Required
6	Page Number	pageNum	Page Number	String	Maximum 8 character	Required

Response:

	Data Element	Field Name	Description	Format	Length	M/O	Remark
1	Total Records	totalRecord	Total Records	String	Maximum 8 character	Required
2	Total Pages	totalPage	Total Pages	String	Maximum 8 character	Required
3	Record Number	recordNum	Record Number	String	Maximum 8 character	Required
2	Record List	recordList	each element is a complex element that includes the following sub-elements:
2.1	sub-elements of each element in the list	cardNumber	Card Number	String	Maximum 19 character	Optional
2.2		retrievalRefNo	retrieval Reference Number	String	Maximum 12 characters	Required
2.3		approvalCode	Transaction Approval Code	String	Maximum 6 characters	Optional	YYYYMMDD
2.4		tranId	Transaction Serial Number	String	Maximum 32 characters	Required	HHMISS
2.5		tranDate	Transaction Date	String	8 characters	Required
2.6		tranTime	Transaction Time	String	6 characters	Required
2.7		tranType	Transaction Type C-Cash Withdraw D-Deposit G-Purchase H-Refund	String	1 characters	Required
2.8		tranCode	Transaction Code	String	Maximum 10 characters	Required
2.9		tranName	Transaction Description	String	Maximum 60 characters	Required
2.10		merchantId	Merchant Id	String	Maximum 15 characters	Required
2.11		merchantName	Merchant Name	String	Maximum 40 characters	Required
2.12		tranCurrency	Transaction Currency	String	Maximum 3 character	Required
2.13		tranAmount	Transaction Amount	String	16,2	Required
2.14		billCurrency	Bill Currency	String	Maximum 3 character	Required
2.15		billAmount	Bill Amount	String	16,2	Required
2.16		feeAmount	Fee Amount	String	16,2	Required
2.17		acctBalance	Account Balance	String	16,2	Required
2.18		tranStatusCode	Transaction Status Code	String	Maximum 2 character	Required
2.19		tranStatusDesc	Transaction Status Description	String	Maximum 40 characters	Required