Status Inquiry - API GPN
Integration of the Status Inquiry API on GPN is required so that Merchants can check the current status of the transaction process carried out by the Customer whether the status is success, fail, and others. So that the system can have a report on that information.
The integration of Inquiry status on GPN aims to allow Merchants to connect with the API system to check the status of the GPN payment method on a regular basis.
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, NICEPAY strongly encourage Merchants to verify the notification using the Status Inquiry - API GPN.
Notification Handling is very useful to minimize the occurrence of Fraud. We strongly encourage Merchants to verify Notification Handling. You can read more detailed information about Notification Handling on Notification - API GPN
The following is a list of parameters for requesting a status inquiry in the GPN transaction process.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20221114114338 |
tXid Required | AN | 30 | Transaction Id | IONPAYTEST01202212071629087180 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
referenceNo Required | ANS | 40 | Merchant Order No | 815123412341 |
amt Required | N | 12 | Transaction Amount | 10000 |
merchantToken Required | AN | 255 | Merchant Token | 4b11d820b0d2ef509715e7b923430643416efc0df4ca2ba2d4b66eb549e074bd |
The following is a list of responses to request status inquiry on the GPN transaction process.
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | paid |
tXid | AN | 30 | Transaction ID | IONPAYTEST01202212071629087180 |
iMid | AN | 10 | Merchant Id | IONPAYTEST |
referenceNo | ANS | 40 | Merchant Ref. No | 815123412341 |
payMethod | N | 2 | 09 | |
amt | N | 12 | Payment Amount | 10000 |
CancelAmt | N | 12 | Cancel amount | null |
reqDt | N | 8 | Transaction request date (YYYYMMDD) | 20221207 |
reqTm | N | 6 | Transaction request time (HH24MISS) | 162908 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221207 |
transTm | N | 6 | Transction Time (HH24MISS) | 162908 |
depositDt | N | 8 | Transaction deposit date (YYYYMMDD) | null |
depositTm | N | 6 | Transaction deposit time (HH24MISS) | null |
currency | A | 3 | Currency | IDR |
goodsNm | AN | 100 | Goods Name | Test Transaction Nicepay |
billingNm | A | 100 | Buyer name | John Doe |
status | N | 1 | 0 | |
instmntType | N | 2 | 1 | |
instmntMon | N | 2 | Installment Month | 1 |
cardNo | N | 20 | Card Number | 62210082****0590 |
preauthToken | AN | 64 | Pre-Auth Token | null |
issuBankCd | A | 4 | OTHR | |
acquBankCd | A | 4 | BNIN | |
vacctValidDt | N | 8 | VA expiry date (YYYYMMDD) | null |
vacctValidTm | N | 6 | VA expiry time (HH24MISS) | null |
vacctNo | N | 20 | VA Number | null |
bankCd | A | 4 | null | |
payNo | N | 12 | Payment Number | null |
mitraCd | A | 4 | null | |
receiptCode | ANS | 20 | Authorization Number | null |
recurringToken | AN | 255 | Recurring Token (Needed for Recurring Payment) | null |
ccTransType | N | 2 | 1 | |
payValidDt | N | 8 | CVS expiry date (YYYYMMDD) (CVS) | null |
payValidTm | N | 6 | CVS expiry time (HH24MISS) (CVS) | null |
mRefNo | AN | 20 | Bank reference No (Direct Debit) | null |
acquStatus | N | 2 | Status Bank Acquiring | 20 |
cardExpYymm | N | 4 | Expiry (YYMM) | 2612 |
acquBankNm | A | 255 | Acquiring Bank Name | BNI |
issuBankNm | A | 255 | Issuing Bank Name | OTHER |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) | null |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) | null |
paymentTrxSn | AN | 32 | Payment transaction number | null |
cancelTrxSn | AN | 128 | Cancel Transaction Number | null |
userId | AN | 128 | QRIS User ID Hash | null |
shopId | AN | 32 | Shop Id | null |
The following is additional response list information from request status inquiry in other transaction processes.
Parameter | Type | Size | Description | Example / Notes |
mitraCd | A | 4 | (CVS, Direct Debit, E-Wallet, Payloan) | null |
payNo | N | 12 | CVS number (CVS) | null |
payValidDt | N | 8 | CVS expiry date (YYYYMMDD) (CVS) | null |
payValidTm | N | 6 | CVS expiry time (HH24MISS) (CVS) | null |
receiptCode | ANS | 20 | Authorization code (CVS) | null |
mRefNo | AN | 20 | Bank reference No (Direct Debit) | nul |