Transaction

List transactions#

GET /transactions

Returns a list of transactions.

Parameters#

Request Body
Example

Name	Type	Required	Description
pageNo	integer(int32)	true	Page index to navigate through all the pages
pageSize	integer(int32)	true	Number of transaction per page. Min: 5 Max: 100
sortBy	string	false	Field name to be sorted the result list (default is TransactionID)
sortDirection	string	false	ASC or DESC (default is DESC)
transactionId	string(20)	false	Transaction Unique ID
merchantId	string(50)	false	Merchant Unique ID
currency	string(3)	false	Transaction currency as defined by ISO4217. eg: 764, 840 for THB, USD respectively.
channel	string(3)	false	Transaction channel name
terminalId	string(25)	false	Terminal Unique ID
invoice	string(25)	false	Invoice number
payerAccountNo	string(20)	false	Credit card number that is masked or other payer identity
payerName	string(25)	false	Payer name
approvalCode	string(6)	false	Approval code of the transaction
dateFrom	string	false	Transaction from date. Format: "DD/MM/YYYY" or "DD/MM/YYYY HH:mm:ss" Note that if date format "DD/MM/YYYY" is used, the time for this field will assume to be 00:00:00.
dateTo	string	false	Transaction to date. Format: "DD/MM/YYYY" or "DD/MM/YYYY HH:mm:ss" Note that if date format "DD/MM/YYYY" is used, the time for this field will assume to be 00:00:00.
amountFrom	string(13)	false	Transaction amount from. Amount should always contain two decimal points i.e. Amount "100.00" is defined as "100.00", Amount "99.12" is defined as "99.12"
amountTo	string(13)	false	Transaction amount to. Amount should always contain two decimal points i.e. Amount "100.00" is defined as "100.00", Amount "99.12" is defined as "99.12"
qrCodeID	integer(int64)	false	Unique identifier of QR code
statusCode	string	false	Transaction status code. See Appendix C.2
maid	string(6)	false	MasterCard Merchant Assigned Identifier
mvv	string(6)	false	VISA Merchant Verification Value
checkSum	string	true	Checksum of the query string

Returns#

Response Body
Example

Name	Type	Required	Description
responseCode	string	true	See Appendix A
pageInfo.totalPage	integer	true	Number of total page
pageInfo.totalRecord	integer	true	Number of total record
transaction.transactionId	string	true	Transaction Unique ID
transaction.merchantId	string	true	Merchant Unique ID
transaction.merchantName	string	true	Merchant name
transaction.terminalId	string	true	Terminal Unique ID
transaction.invoice	string	false	Invoice number
transaction.amount	string	true	Transaction amount
transaction.currency	string	true	Transaction currency as defined by ISO4217. eg: 764, 840 for THB, USD respectively.
transaction.transactionDate	string	true	Transaction datetime. Format: "DD/MM/YYYY" or "DD/MM/YYYY HH:mm:ss" Note that if date format "DD/MM/YYYY" is used, the time for this field will assume to be 00:00:00.
transaction.channelCode	string	true	Transaction channel code
transaction.channelName	string	true	Transaction channel name
transaction.statusCode	string	true	Transaction status code. See Appendix C.2
transaction.statusDescription	string	true	Unique identifier of QR code
transaction.qrCodeID	integer	true	Unique identifier of QR code
transaction.maid	string(6)	false	MasterCard Merchant Assigned Identifier
transaction.mvv	string(6)	false	VISA Merchant Verification Value
transaction.seqNo	integer	true	Sequence number of this object in an array
checkSum	string	true	Checksum of the query string

Get a transaction#

GET /transactionDetails

Returns details of a transaction.

Parameters#

Request Body
Example

Name	Type	Required	Description
transactionID	integer(20)	true	Unique ID of the transaction
checkSum	string	true	Checksum of the query string. See Checksum for how the checksum value is calculated

Returns#

Response Body
Example

Name	Type	Required	Description
responseCode	string	true	See Appendix A
transactionId	string	true	Transaction Unique ID
company	string	true	Company name
merchantId	string	true	Merchant Unique ID
merchantName	string	true	Merchant name
terminalId	string	true	Terminal Unique ID
invoice	string	false	Invoice number
note	string	false	Additional note
originalAmount	string	true	Original paid amount
transactionCurrency	string	true	Original transaction currency as defined by ISO4217. eg: 764, 840 for THB, USD respectively.
merchantAmount	string	true	Merchant amount
merchantFee	string	true	Merchant fee amount
merchantVAT	string	true	Merchant VAT amount
merchantNetAmount	string	true	Merchant net amount after deduct fee and VAT
merchantCurrency	string	true	Original transaction currency as defined by ISO4217
transactionDate	string	true	Transaction datetime. Format: "DD/MM/YYYY HH:mm:ss"
channelCode	string	true	Transaction channel code
channelName	string	true	Transaction channel name
statusCode	string	true	Transaction status code. See Appendix C.2
statusDescription	string	true	Unique identifier of QR code
qrCodeID	integer	true	Unique identifier of QR code
traceNo	string	false	System trace audit number
merchantPAN	string	false	Merchant payer account number
maid	string(6)	false	MasterCard Merchant Assigned Identifier
mvv	string(6)	false	VISA Merchant Verification Value
discountAmount	string	conditional	The deduction amount of the discount coupon from UPI
checkSum	string	true	Checksum of the query string

Get a transaction by QR ID#

GET /transactionDetailsByQR

Returns details of a transaction by QR ID. Only payment transaction details will be retrieved in this request. Can be requested by providing dynamic QR code ID.

Parameters#

Request Body
Example

Name	Type	Required	Description
qRCodeID	integer(20)	true	Unique identifier of QR code
checkSum	string	true	Checksum of the query string. See Checksum for how the checksum value is calculated

Returns#

Response Body
Example

Name	Type	Required	Description
responseCode	string	true	See Appendix A
transactionId	string	true	Transaction Unique ID
company	string	true	Company name
merchantId	string	true	Merchant Unique ID
merchantName	string	true	Merchant name
terminalId	string	true	Terminal Unique ID
invoice	string	false	Invoice number
note	string	false	Additional note
originalAmount	string	true	Original paid amount
transactionCurrency	string	true	Original transaction currency as defined by ISO4217. eg: 764, 840 for THB, USD respectively.
merchantAmount	string	true	Merchant amount
merchantFee	string	true	Merchant fee amount
merchantVAT	string	true	Merchant VAT amount
merchantNetAmount	string	true	Merchant net amount after deduct fee and VAT
merchantCurrency	string	true	Original transaction currency as defined by ISO4217
transactionDate	string	true	Transaction datetime. Format: "DD/MM/YYYY HH:mm:ss"
channelCode	string	true	Transaction channel code
channelName	string	true	Transaction channel name
statusCode	string	true	Transaction status code. See Appendix C.2
statusDescription	string	true	Unique identifier of QR code
qrCodeID	integer	true	Unique identifier of QR code
traceNo	string	false	System trace audit number
merchantPAN	string	false	Merchant payer account number
maid	string(6)	false	MasterCard Merchant Assigned Identifier
mvv	string(6)	false	VISA Merchant Verification Value
discountAmount	string	conditional	The deduction amount of the discount coupon from UPI
checkSum	string	true	Checksum of the query string