Status Inquiry - API Virtual Account
Integration of the Status Inquiry API on Virtual Accounts is required so that Merchants can check the ongoing 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.
Integration Inquiry status on the Virtual Account aims so the Merchant can connect to the API system to perform status checking on the Virtual Account payment method regularly.
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 recommend Merchant to verify the notification using the Status Inquiry - API Virtual Account.
Notification Handling is very useful to minimize the risk of Fraud. We strongly encourage Merchants to verify Notification Handling using Notification - API Virtual Account SNAP.
The following is a list of parameters for requesting a status inquiry in the virtual account transaction process.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20221215091222 |
tXid Required | AN | 30 | Transaction Id | NORMALTEST02202212150929011967 |
iMid Required | AN | 10 | Merchant ID | NORMALTEST |
referenceNo Required | ANS | 40 | Merchant Order No | ordNo20221215091214 |
amt Required | N | 12 | Transaction Amount | 1000 |
merchantToken Required | AN | 255 | Merchant Token | ea6e691a895f1ccc0602f534205ee60bc552552dde7610062cd048ea6c87965e |
The following is a list of responses to requests for status inquiry on virtual account transaction processes.
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | paid |
tXid | AN | 30 | Transaction ID | NORMALTEST02202212150929011967 |
iMid | AN | 10 | Merchant Id | NORMALTEST |
referenceNo | ANS | 40 | Merchant Ref. No | ordNo20221215091214 |
payMethod | N | 2 | 02 | |
amt | N | 12 | Payment Amount | 10000 |
CancelAmt | N | 12 | Cancel amount | null |
reqDt | N | 8 | Transaction request date (YYYYMMDD) | 20221215 |
reqTm | N | 6 | Transaction request time (HH24MISS) | 092901 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221215 |
transTm | N | 6 | Transction Time (HH24MISS) | 092901 |
depositDt | N | 8 | Transaction deposit date (YYYYMMDD) | null |
depositTm | N | 6 | Transaction deposit time (HH24MISS) | null |
mitraCd | A | 4 | ALMA | |
instmntMon | N | 2 | Installment Month | null |
instmntType | N | 2 | 1 | |
cardNo | N | 20 | Credit Card Number | null |
preauthToken | AN | 64 | Pre-Auth Token | null |
acquBankCd | A | 4 | null | |
issuBankCd | A | 4 | null | |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) | 20221231 |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) | 235959 |
vacctNo | N | 20 | Virtual Account No. | 9912304000001487 |
bankCd | A | 4 | CENA | |
payNo | N | 12 | CVS number (CVS) | null |
mitraCd | A | 4 | null | |
receiptCode | ANS | 20 | Authorization No | null |
recurringToken | AN | 64 | Recurring Payment Token | null |
ccTransType | N | 2 | null | |
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 |
cardExpYymm | N | 4 | Card Expiration (YYMM) | null |
acquBankNm | A | 255 | Acquiring Bank Name | null |
issuBankNm | A | 255 | Issuing Bank Name | null |
depositDt | N | 8 | Deposit Date (YYYYMMDD) | 20221215 |
depositTm | N | 6 | Deposit Time (HH24MISS) | 092936 |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) | null |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) | null |
paymentTrxSn | N | 32 | Payment Transaction Number | null |
cancelAmt | N | 12 | Cancel Amount | null |
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 | John Doe |
status | N | 1 | 0 | |
userId | AN | 128 | QRIS User ID Hash | null |
shopId | AN | 32 | Shop Id | null |
The following is a list of additional responses from the inquiry status request in the virtual account transaction process.
Parameter | Type | Size | Descriprion |
bankCd | A | 4 | |
vacctNo | N | 16 | Bank Virtual Account Number |
vacctValidDt | N | 8 | VA expiry date (YYYYMMDD) |
vacctValidTm | N | 9 | VA expiry time (HH24MISS) |