---
title: Status Inquiry - API Convenience Store
slug: en/nicepay-api-non-snap-status-inquiry-api-convenience-store
description: Information about Non-SNAP Payment API - Status Inquiry - Convenience Store API available on NICEPAY system
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/7g_kgpp8baE_LUmhj4tvP_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2022-12-01T07:47:49.000Z
---
# About API Convenience Store Status Inquiry
***
Integration of the Status Inquiry API into the Convenience Store is necessary so that Merchants can check the ongoing status of the transaction process carried out by the Customer, whether the status is successful, failed or failed, and others. So that the system can have a report on that information.
# API Convenience Store Status Inquiry
***
Integration of Inquiry Status at Convenience Store aims to enable Merchants to connect with the API system to check the status of Convenience Store payment methods 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` |
:::hint{type="info"}
When your `dbProcessUrl` received a notification, we strongly encourage Merchants to verify the notification using the [Status Inquiry - API Convenience Store](docId:5njLA-ebfHTTNnLFvZ73P).
:::
:::hint{type="info"}
`Notification Handling` is very useful to minimize the risk of Fraud. We strongly encourage Merchants to verify `Notification Handling` through [Notification - API Convenience Store](docId\:GSy1EhZ56UxBkeA3SbLf9).
:::
## Request Parameter for Convenience Store Status Inquiry
***
The following is a list of parameters for requesting a status inquiry on a Convenience Store transaction process.
| **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** |
| ------------------------------------------------------------ | -------- | -------- | -------------------------------------- | ---------------------------------------------------------------- |
| `timeStamp`
Required
| N | 14 | Request Timestamp (`YYYYMMDDHH24MISS`) | 20221012080918 |
| `tXid
`
Required
| AN
| 30 | Transaction ID | IONPAYTEST00202212091011228108 |
| `iMid`
Required
| AN | 10 | Merchant ID | IONPAYTEST |
| `referenceNo
`
Required
| ANS | 40 | Merchant Order Number | ORDER20221012080918 |
| `amt
`
Required
| N
| 12
| Transaction Amount | 1 |
| `merchantToken
`
Required
| AN
| 255
| Merchant token | 666b397e7bce1d65e2cc553205ebab7330f9b2da8293b02c342279c1b6999ceb |
## Response Parameter for Convenience Store Status Inquiry
***
The following is a list of responses to requests for status inquiry in the Convenience Store transaction process.
| **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** |
| ------------- | -------- | -------- | ----------------------------------------------------------- | ------------------------------ |
| `resultCd` | N | 4 | [Result Code](docId:9eC3yH9CQqpb6cRWauWWO) | 0000 |
| `resultMsg
` | AN | 255 | Result Message: [Error Code](docId\:FsX1GESJKxOp0T9rvUHp_) | unpaid |
| `tXid` | AN | 30 | Transaction ID
| IONPAYTEST00202212091011228108 |
| `iMid` | AN | 10 | Merchant ID
| IONPAYTEST |
| `referenceNo` | ANS | 40 | Merchant Reference Number
| ORDER20221012080918 |
| `payMethod` | N | 2 | [Payment Method Code](docId\:NQ1y7vMa25ZtvQHN5He6W) | 03 |
| `amt` | N | 12 | Payment Amount | 1 |
| `CancelAmt` | N | 12 | Cancel Amount | |
| `reqDt` | N
| 8 | Transaction Request Date (`YYYYMMDD`)
| 20221209 |
| `reqTm` | N
| 6 | Transaction Request Time (`HH24MISS`)
| 101122 |
| `transDt` | N | 8 | Transaction Date (`YYYYMMDD`)
| |
| `transTm` | N | 6 | Transaction Time (`HH24MISS`)
| |
| `depositDt
` | N | 8 | Transaction Deposit Date (`YYYYMMDD`) | |
| `depositTm
` | N | 6 | Transaction Deposit Time (`HH24MISS`) | |
| `currency` | A | 3 | Currency | IDR |
| `goodsNm
` | AN | 100 | Goods Name | Test Transaction NICEPAY |
| `billingNm` | A | 100 | Buyer name
| John Doe |
| `status
` | N | 1 | [Payment Status Code](docId\:QPNU5VtJKCzpxFRhiayAS) | 3 |
## Additional Response Parameter for Others Status Inquiry
***
The following is additional response list information from request status inquiry in other transaction processes.
| **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** |
| ------------- | -------- | -------- | --------------------------------------------------------------------------------------- | ------------------- |
| `mitraCd` | A | 4 |
[Mitra Code](docId:0luP35KfOWksiSrzKx6yZ) (CVS, Direct Debit, E-Wallet, Paylater) | ALMA |
| `payNo` | N | 12 | CVS Number (CVS)
| 9041091011228108 |
| `payValidDt` | N | 8 | CVS Expiry Date (`YYYYMMDD`) (CVS)
| 20221216 |
| `payValidTm` | N | 6 | CVS Expiry Time (`HH24MISS`) (CVS) | 235959 |
| `receiptCode` | ANS | 20 | Authorization Code (CVS)
| |
| `mRefNo` | AN | 20 | Bank Reference Number (Direct Debit)
| |
## Sample JSON for Convenience Store Status Inquiry
***
:::CodeblockTabs
JSON Request
```json
{
"timeStamp":"20221012080918",
"tXid":"IONPAYTEST00202212091011228108",
"referenceNo":"ORDER20221012080918",
"iMid":"IONPAYTEST",
"amt":"1",
"merchantToken":"666b397e7bce1d65e2cc553205ebab7330f9b2da8293b02c342279c1b6999ceb"
}
```
JSON Response
```json
{
"tXid": "IONPAYTEST00202212091011228108",
"iMid": "IONPAYTEST",
"currency": "IDR",
"amt": "1",
"instmntMon": null,
"instmntType": "1",
"referenceNo": "ORDER20221012080918",
"goodsNm": "Test Transaction Nicepay",
"payMethod": "03",
"billingNm": "John Doe",
"reqDt": "20221209",
"reqTm": "101122",
"status": "3",
"resultCd": "0000",
"resultMsg": "unpaid",
"cardNo": null,
"preauthToken": null,
"acquBankCd": null,
"issuBankCd": null,
"vacctValidDt": null,
"vacctValidTm": null,
"vacctNo": null,
"bankCd": null,
"payNo": "9041091011228108",
"mitraCd": "ALMA",
"receiptCode": null,
"cancelAmt": null,
"transDt": "20221209",
"transTm": "101122",
"recurringToken": null,
"ccTransType": null,
"payValidDt": "20221216",
"payValidTm": "235959",
"mRefNo": null,
"acquStatus": null,
"cardExpYymm": null,
"acquBankNm": null,
"issuBankNm": null,
"depositDt": null,
"depositTm": null,
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null
}
```
Java Request
```java
//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");
```
:::