UPP Payment Query Parameters

The following parameters are provided to PayMaster for a payment query request. Once PayMaster retrieves the payment transaction status from the database, it will return the retrieved information as a response to the merchant's server.

Request Parameters

Mandatory Fields

Field Name	Type	Length	Description	Example
PaymentID	String	3	Payment Method/Function.	"U02" – UPP Payment Status Query
MerchantID	String	15	Merchant ID.	"000010000099939"
ServiceID	String	3	Service ID.	"FNX"
MerchRefNo	String	40	Unique merchant reference number.	"MYB2023030315435025LL"
QueryRespURL	String	512	Query response page.	"https://XXX.XXXXX.XXX/query.jsp"

Response Parameters

Mandatory Fields

Field Name	Type	Length	Description	Example
MerchantID	String	15	Merchant ID.	"000010000099939"
TxnStatus	String	2	Payment status. Appendix 3	"00"
MerchRefNo	String	40	Unique merchant reference number.	"MYB2023030315435025LL"
QueryStatus	String	2	Query status. Appendix 3	"00"

Optional Fields

Field Name	Type	Length	Description	Example
CardNo	String	19	Card number. Note: Only for Credit/Debit Payment method.	"545301XXXXXX5323"
TxnDtTm	String	14	Transaction date and time. Format: yyyymmddhhmmss	"20230303154833"
TxnAmt	String (Numeric)	12	Transaction amount.	"100.00"
CurrCode	String	3	Currency code.	"458"
AuthIDRespCode	String	6	Authorization ID response code. Note: Generated by issuer and forwarded to Acquirer to indicate the approval of a transaction. Only for successful payment.	"457180"
ExpTxnAmt	String	1	Exponent of transaction amount.	"0"
RetrievalRefNo	String	12	Retrieval Reference Number. Note: Available if this field returned by Acquirer in the response message.	"306274008021"
OrigTxnAmt	String (Numeric)	12	Original transaction amount.	"10000"
OrigCurrCode	String	3	Original transaction currency numeric code.	"458"
TxnChannel	String	3	Transaction channel.	"WEB" - Web Channel (default), "API"- via API, "DIR" - Direct, "GDS" - GDS Channel, "OTH" – Others
FICode	String	20	Financial institution Code. Note: Available for FPX payment with UppPymtMode = 01.	"CIMB"
PymtGwRefNo	String	20	Payment Gateway Reference Number.	"230303154349AC010FNX"
TxnStatDetCde	String	4	Transaction status detail code.	"0000"
TxnStatMsg	String	256	Transaction status message	"Approved"
ServiceID	String	3	Service Identifier provided by PayMaster.	"FNX"
MerchHostID	String	8	Merchant host identifier.	"M2022121"
MerchSessionID	String	256	Merchant session ID.	"2023030315435025"
OrderRefNo	String	34	Order reference number.	"OTMEGASTORE-20010831-ONLINE-007"
FPXRefNo	String	20	Unique FPX reference number generated by FI. Note: Available for FPX payment and existed in the FI system with UppPymtMode = 01.	"3143323587217932"
UppPymtMode	String	2	Payment mode chosen at UPP page.	"00" - Credit/Debit Card Payment, "01" - FPX Payment, "99" - Unknown or some error occurred during the processing
OrigRespCode	String	8	Original response code. Appendix 3	" "
ExpOrigTxnAmt	String	1	Exponent of original transaction amount.	"2"

MerchRefNo, MerchantID, OrderRefNo, CardNo, TxnChannel, CurrCode, TxnAmt, ExpTxnAmt, OrigCurrCode, OrigTxnAmt, ExpOrigTxnAmt, MerchHostID and MerchSessionID have the same value as in prior payment request.

Example Message

Request

UPP Payment Query Request

{
    "paymentID": "U02",
    "merchantID": "000010000099939",
    "serviceID": "",
    "merchRefNo": "MYB2023030315435025LL",
    "queryRespURL": ""
}

Response

UPP Payment Query Response

{
    "merchantID": "000010000099939",
    "cardNo": "545301XXXXXX5323",
    "txnDtTm": "20230303154833",
    "txnAmt": "100.00",
    "txnStatus": "00",
    "currCode": "458",
    "authIDRespCode": "457180",
    "expTxnAmt": "2",
    "retrievalRefNo": "306274008021",
    "origRespCode": "",
    "pymtGwRefNo": "230303154349AC010FNX",
    "txnStatDetCde": "0000",
    "txnStatMsg": "Approved",
    "serviceID": "FNX",
    "merchHostID": "",
    "merchSessionID": "2023030315435025",
    "merchRefNo": "MYB2023030315435025LL",
    "orderRefNo": "",
    "uppPymtMode": "00",
    "queryStatus": "00",
    "origCurrCode": "458",
    "origTxnAmt": "10000",
    "expOrigTxnAmt": "0",
    "FICode": "",
    "FPXRefNo": "",
    "txnChannel": "WEB",
}