NICEPAY API V2 Payment Status Inquiry - API QRIS

Status Inquiry - API QRIS

10min

About API QRIS Status Inquiry 
﻿
Integration of the Status Inquiry API into QRIS is required so that Merchants can check the ongoing status of the transaction process carried out by the Customer, whether the status is a success, failed, and others. So the system can have a report on that information.
﻿
API QRIS Status Inquiry 
﻿
The integration of Inquiry status into QRIS aims to enable merchants to connect with the API system to check the status of the QRIS payment method.

API Endpoint
/nicepay/direct/v2/inquiry
Request Method
﻿POST﻿
Description
Performs Inquiry Request to NICEPAY for Status Checking
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format
application/json
When your dbProcessUrl received a notification, we strongly encourage Merchants to verify the notification using the Status Inquiry - API QRIS﻿.
Notification Handling is very useful to minimize the risk of Fraud. We strongly encourage Merchants to verify Notification Handling . You can read more detailed information about Notification Handling on Notification - API QRIS﻿.
﻿
Request Parameter for QRIS Status Inquiry  
﻿
The following is a list of parameters for requesting a status inquiry in the QRIS transaction process.
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20221208091279
tXid
Required
﻿
AN
30
Transaction Id
IONPAYTEST08202212080918308275
iMid
﻿Required
﻿
AN
10
Merchant ID
IONPAYTEST
referenceNo
Required
﻿
ANS
40
Merchant Order No
ORD54321
amt
Required
﻿
N
12
Transaction Amount	
5
merchantToken
Required
﻿
AN
255
Merchant Token
52d30865f174e445cf731403b010ae099314edea9c399f7940fb2020d4045465
﻿
Response Parameter for QRIS Status Inquiry  
﻿
The following is a list of responses to requests for status inquiry in the QRIS transaction process.
Parameter
Type
Size
Description
Example / Notes
resultCd
N
4
﻿Result Code﻿ 
0000
resultMsg
AN
255
Result Message: Error Code﻿ 
PAID
tXid
AN
30
Transaction ID
IONPAYTEST08202212080918308275
iMid
AN
10
Merchant Id
IONPAYTEST
referenceNo
ANS
40
Merchant Ref. No
ORD54321
payMethod
N
2
﻿Payment Method Code﻿ 
08
amt
N
12
Payment Amount
5
CancelAmt
N
12
Cancel amount
null
reqDt
N
8
Transaction request date (YYYYMMDD)
20221208
reqTm
N
6
Transaction request time (HH24MISS)
091830
transDt
N
8
Transaction Date (YYYYMMDD)
20221208
transTm
N
6
Transction Time (HH24MISS)
091949
depositDt
N
8
Transaction deposit date (YYYYMMDD)
Null
depositTm
N
6
Transaction deposit time (HH24MISS)
﻿
mitraCd
A
4
﻿Mitra Code﻿ 
QSHP
instmntMon
N
2
Installment Month
Null
instmntType
N
2
﻿Installment Type Code﻿ 
1
cardNo
N
20
Credit Card Number 
Null
preauthToken
AN
64
Pre-Auth Token
Null
acquBankCd
A
4
﻿Acquiring Bank Code﻿ 
Null
issuBankCd
A
4
﻿Issuing Bank Code﻿ 
Null
vacctValidDt
N
8
VA Expiry Date (YYYYMMDD)	
Null
vacctValidTm
N
6
VA Expiry Time (HH24MISS)
Null
vacctNo
N
20
Virtual Account No.	
Null
bankCd
A
4
﻿Bank Code﻿ 
Null
payNo
N
12
CVS number (CVS)
Null 
﻿
(For CVS)
receiptCodeF
ANS
20
Authorization No
Null 
﻿
(For Diret Debit)
recurringToken
AN
64
Recurring Payment Token	
Null 
﻿
(For CC)
ccTransType
N
2
﻿Credit Card Transaction Type﻿﻿
Null 
﻿
(For CC)
payValidDt
N
8
Expiry Date (YYYYMMDD)
Null
payValidTm
N
6
Expiry Time (HH24MISS)
Null
mRefNo
AN
18
Bank Reference No
Null
acquStatus
N
2
Purchase Status
1: Normal
2: Recurring
3: Pre-auth
4: Capture
Null 
﻿
(For CC)
cardExpYymm
N
4
Card Expiration (YYMM)
Null 
﻿
(For CC)
acquBankNm
A
4
Acquiring Bank Name
Null 
﻿
(For CC)
issuBankNm
A
255
Issuing Bank Name
﻿
depositDt
N
8
Deposit Date (YYYYMMDD)
Null
﻿
 (For VA)
depositTm
N
6
Deposit Time (HH24MISS)
Null 
﻿
(For VA)
paymentExpDt
N
6
QR Payment Expiry Date (YYYYMMDD)
20221208
paymentExpTm
N
6
QR Payment Expiry Time (HH24MISS)
092330
paymentTrxSn
N
32
Payment Transaction Number
115045570008290314
cancelTrxSn
AN
32
Cancel Transaction Number
null
currency
A
3
Currency
IDR
goodsNm
AN
100
Goods Name
Test Transaction Nicepay
billingNm
A
100
Buyer name
Andi pamungkas
status
N
1
﻿Payment Status Code﻿﻿
0
userId
AN
128 
QRIS User ID Hash
115045570008290314
shopId
AN
32
Shop Id
NICEPAY
﻿
Additional Response Parameter for QRIS Status Inquiry
﻿
The following is information on a list of additional responses to requests for status inquiry in the QRIS transaction process.
Parameter
Type
Size
Description
mitraCd
A
4
﻿Mitra Code﻿﻿
cancelAmt
N
12
Cancel amount
paymentTrxSn
N
32
Payment Transaction Number
paymentExpDt
N
6
QR Payment Expiry Date (YYYYMMDD)
shopId
AN
32
Shop Id
paymentExpTm
N
6
QR Payment Expiry Time (HH24MISS)
cancelTrxSn
AN
32
Cancel Transaction Number
userId
AN
128
QRIS User ID Hash
﻿

Sample JSON for QRIS Status Inquiry 
﻿
JSON Request
JSON Response
Java Request
//Inquiry Registration//
nicePay.setTimeStamp("20221208091279");
nicePay.setiMid("IONPAYTEST");
nicePay.setAmt("10000");
nicePay.setReferenceNo("ordNo20221202141217");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getMerchantToken());
nicePay.settXid("IONPAYTEST08202212080918308275");

// Request Inquiry
nicePay.inquiry();

// Response String //
System.out.println("Final Response String : " + nicePay.getResponseString());

String resultCd = nicePay.Get("resultCd");
String resultMsg = nicePay.Get("resultMsg");
String tXid = nicePay.Get("tXid");
String referenceNo = nicePay.Get("referenceNo");
String payMethod = nicePay.Get("payMethod");
String status = nicePay.Get("status")
String amt = nicePay.Get("amt");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String shopId = nicePay.Get("shopId");
//Inquiry Registration//
nicePay.setTimeStamp("20221208091279");
nicePay.setiMid("IONPAYTEST");
nicePay.setAmt("10000");
nicePay.setReferenceNo("ordNo20221202141217");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getMerchantToken());
nicePay.settXid("IONPAYTEST08202212080918308275");

// Request Inquiry
nicePay.inquiry();

// Response String //
System.out.println("Final Response String : " + nicePay.getResponseString());

String resultCd = nicePay.Get("resultCd");
String resultMsg = nicePay.Get("resultMsg");
String tXid = nicePay.Get("tXid");
String referenceNo = nicePay.Get("referenceNo");
String payMethod = nicePay.Get("payMethod");
String status = nicePay.Get("status")
String amt = nicePay.Get("amt");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String shopId = nicePay.Get("shopId");
﻿
﻿

Bank Indonesia already release API Standard relate to the Payment listed on Peraturan Anggota Dewan Gubernur No 23/15/PADG/2021 about Standar Nasional Open Application Interface Pembayaran (SNAP) Implementation.

As the form of suppport and compliance to Bank Indonesia Rules, NICEPAY drives all Merchant to conduct the migration to API SNAP BI.

All Merchants aim to complete the API SNAP BI migration on June 2024.

API Endpoint	/nicepay/direct/v2/inquiry
Request Method	POST
Description	Performs Inquiry Request to NICEPAY for Status Checking
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format	application/json

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20221208091279
tXid Required	AN	30	Transaction Id	IONPAYTEST08202212080918308275
iMid Required	AN	10	Merchant ID	IONPAYTEST
referenceNo Required	ANS	40	Merchant Order No	ORD54321
amt Required	N	12	Transaction Amount	5
merchantToken Required	AN	255	Merchant Token	52d30865f174e445cf731403b010ae099314edea9c399f7940fb2020d4045465

Status Inquiry - API QRIS

About API QRIS Status Inquiry

API QRIS Status Inquiry

Request Parameter for QRIS Status Inquiry

Response Parameter for QRIS Status Inquiry

Additional Response Parameter for QRIS Status Inquiry

Sample JSON for QRIS Status Inquiry

Welcome to NICEPAY DOCS