---
title: Status Inquiry - API Credit Card
slug: en/nicepay-api-non-snap-status-inquiry-api-credit-card
description: Information about Non-SNAP Payment API - Status Inquiry - Credit Card API available on NICEPAY system
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/OQbd3zq_ivFg-yJlVr1Q3_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2022-08-31T06:14:48.000Z
---
# About Status Inquiry - API Credit Card
***
Integration with the Status Inquiry API on Credit Cards is required so that Merchants can check the status of ongoing transaction processes, whether they are successful, failed, and other status.
# Status Inquiry - API Credit Card
***
The integration of status inquiries on Credit Cards aims to enable Merchants to connect with the API system which has function to checking the status of Credit Card payment methods.
| **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, NICEPAY strongly recommend Merchant to verify the notification using the [Status Inquiry - API Credit Card](docId\:NTP9jTSSg4RtkebeOh_Dr).
:::
:::hint{type="info"}
`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 Credit Card](docId\:NxFOPoHFnWX1dJqBXsPqq) page.
:::
## Request Parameter for Status Inquiry - API Credit Card
***
The following is a list of request parameters to proceed the status Inquiry request on Credit Card transaction process:
| **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** |
| ------------------------------------------------------------ | -------- | -------- | -------------------------------------- | ----------------------------------- |
| `timeStamp`
Required
| N | 14 | Request Timestamp (`YYYYMMDDHH24MISS`) | 20221214091282 |
| `tXid
`
Required
| AN
| 30 | Transaction ID | IONPAYTEST01202212140949101366 |
| `iMid`
Required
| AN | 10 | Merchant ID | IONPAYTEST |
| `referenceNo
`
Required
| ANS | 40 | Merchant Order Number | ordNo20221214091293
|
| `amt
`
Required
| N
| 12
| Transaction Amount | 5000 |
| `merchantToken
`
Required
| AN
| 255
| Merchant Token | 7eceb5801db4e039223698c4eb9... |
## Response Parameter for Status Inquiry - API Credit Card
***
The following is a list of Response Parameter or the result from the Request Parameter for Status Inquiry Credit Card.
| **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** |
| ---------------- | -------- | -------- | ----------------------------------------------------------- | ------------------------------ |
| `resultCd` | N | 4 | [Result Code](docId:9eC3yH9CQqpb6cRWauWWO) | 0000 |
| `resultMsg
` | AN | 255 | Result Message: [Error Code](docId\:FsX1GESJKxOp0T9rvUHp_) | Paid |
| `tXid ` | AN | 30 | Transaction ID
| IONPAYTEST01202212140949101366 |
| `iMid ` | AN | 10 | Merchant ID
| IONPAYTEST |
| `currency` | A | 3 | Currency | IDR |
| `instmntMon` | N | 2 | Installment Month | 1 |
| `instmntType` | N | 2 | [Installment Type Code](docId:_Wzur5wjwhrDR8YXI-Ppi) | 1 |
| `referenceNo ` | ANS | 40 | Merchant Reference Number
| ordNo20221214091293 |
| `payMethod` | N | 2 | [Payment Method Code](docId\:NQ1y7vMa25ZtvQHN5He6W) | 01 |
| `amt` | N | 12 | Payment Amount | 5000 |
| `CancelAmt` | N | 12 | Cancel amount | null |
| `reqDt ` | N
| 8 | Transaction Request Date (`YYYYMMDD`)**
** | 20221214 |
| `reqTm ` | N
| 6 | Transaction Request Time (`HH24MISS`)
| 094910 |
| `status` | N | 1 | Transaction Status | 0 |
| `transDt` | N | 8 | Transaction Date (`YYYYMMDD`)
| 20221214 |
| `transTm` | N | 6 | Transaction Time (`HH24MISS`)
| 094910 |
| `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 | Goods |
| `billingNm ` | A | 100 | Buyer Name
| John Doe |
| `status`
| N | 1 | [Payment Status Code](docId\:QPNU5VtJKCzpxFRhiayAS) | 0 |
## Additional Response Parameter for Status Inquiry - API Credit Card
***
Here is a list of additional response parameter for the result from the request status inquiry for Credit Card process.
| **Parameter** | **Type** | **Size** | **Description** | **Example / Notes** |
| ---------------- | -------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| `authNo` | N | 10 | Auth Number | 101366 |
| `issuBankCd` | A | 4 | [Issuing Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0) | OTHR |
| `acquBankCd` | A | 4 | [Acquiring Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0) | BMRI |
| `acquBankNm` | A | 255 | Acquiring Bank Name
| Mandiri |
| `vacctValidDt` | N | 8 | VA Expiry Date (`YYYYMMDD`) | null |
| `vacctValidTm` | N | 6 | VA Expiry Time (`HH24MISS`) | null |
| `vacctNo` | N | 20 | Virtual Account Number | null |
| `bankCd` | A | 4 | [Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0) | null |
| `payNo` | N | 12 | CVS Payment Number | null |
| `mitraCd` | A | 4 | [Mitra Code](docId:0luP35KfOWksiSrzKx6yZ) | null |
| `receiptCode` | ANS | 20 | Authorization Number | null |
| `cancelAmt` | N | 12 | Cancel Amount | null |
| `payValidDt` | N | 8 | CVS Expiry Date (`YYYYMMDD`) | null |
| `payValidTm` | N | 6 | CVS Expiry Time (`HH24MISS`) | null |
| `mRefNo` | AN | 20 | Bank Reference Number | null |
| `issuBankNm` | A | 255 | Issuing Bank Name | OTHER |
| `paymentExpDt` | N | 6 | Payment Expiry Date (`YYYYMMDD`) | null |
| `paymentExpTm` | N | 6 | Payment Expiry Time (`HH24MISS`) | null |
| `paymentTrxSn` | AN | 32 | Payment Transaction Number | null |
| `userId` | AN | 128 | QRIS User ID Hash | null |
| `shopId` | AN | 32 | Shop ID | null |
| `cardNo` | ANS | 20 | Masked Card Number | 453211\*1111 |
| `cardExpYymm` | N | 4 | Card Expiration (`YYMM`) | 2712 |
| `instmntMon` | N | 2 | Installment Month | 1 |
| `instmntType` | N | 2 | [Installment Type Code](docId:_Wzur5wjwhrDR8YXI-Ppi) | 1 |
| `preauthToken` | AN | 255 | Pre-Auth Token (Needed for Capture Payment) | null |
| `recurringToken` | AN | 255 | Recurring Token (Needed for Recurring Payment) | null |
| `ccTransType` | N | 2 | [Credit Card Transaction Type](docId:7PAs_VD5YLG4VDurMygWo) | 1 |
| `acquStatus` | N | 2 | Purchase Status
`1`: Normal
`2`: Recurring
`3`: Pre-Auth
`4`: Capture | 10 |
| `acquirerData` | Array | 20 | A dynamic array consisting of a unique reference number RRN that is provided by the Bank Partner when a refund is processed. This reference number can be used by the Customer to track the status of the refund with the Bank. | `"acquirerData": {`
` "rrn": "332608321717"`
` }` |
## Sample Parameter for Status Inquiry - API Credit Card
***
### Request Parameter
:::CodeblockTabs
cURL
```curl
curl --location 'https://dev.nicepay.co.id/nicepay/direct/v2/inquiry' \
--header 'Content-Type: application/json' \
--data '{
"timeStamp": "20221214091282",
"tXid": "IONPAYTEST01202212140949101366",
"iMid": "IONPAYTEST",
"merchantToken": "7eceb5801db4e039223698c4eb9871432217132d8b0483122001a2569e8c7537",
"referenceNo": "ordNo20221214091293",
"amt": "5000"
}'
```
Node.js
```nodejs
const config = {
isProduction: true,
isCloudServer: false,
merchantKey: "YOUR_MERCHANT_KEY",
clientId: "IONPAYTEST",
privateKey: cons.privateKey,
clientSecret: cons.clientSecret,
};
const parameter = {
timeStamp: "20221214091282",
tXid: "IONPAYTEST01202212140949101366",
iMid: "IONPAYTEST",
referenceNo: "ordNo20221214091293",
amt: "5000",
};
const secondVersion = new SecondApiVersion(config);
const response = await secondVersion.requestAPI(parameter, "/direct/v2/inquiry");
console.log("Inquiry Response:", response);
```
```java
config = NICEPay.builder()
.isProduction(false)
.isCloudServer(false)
.timestamp("20221214091282")
.build();
String timestamp = "20221214091282";
String imid = "IONPAYTEST";
String merchantKey = TestingConstants.MERCHANT_KEY;
String reffNo = "ordNo20221214091293";
String amount = "5000";
InquiryStatus requestData = InquiryStatus.builder()
.timeStamp(timestamp)
.tXid("IONPAYTEST01202212140949101366")
.iMid(imid)
.referenceNo(reffNo)
.merchantToken(timestamp, imid, reffNo, amount, merchantKey)
.amt(amount)
.build();
NICEPayResponseV2 result = V2CardService.callV2InquiryStatus(requestData, config);
System.out.println("Inquiry Response: " + result);
```
```python
bodyInquiry = (
builderInquiry.BuildInquiry()
.setTxid("IONPAYTEST01202212140949101366")
.setReferenceNo("ordNo20221214091293")
.setAmt("5000")
.build()
)
environment = (
builderEnvironment.BuildEnvironment()
.isCloud(False)
.isProduction(False)
.build()
)
response = ServiceNicepay.serviceInquiry(
DataGenerator.getInquiryBody(bodyInquiry.jsonInquiry()),
environment
)
```
C#
```csharp
string merchantKey = config.MerKey;
string clientId = config.ClientId;
string timestamp = "20221214091282";
string tXid = "IONPAYTEST01202212140949101366";
string refNo = "ordNo20221214091293";
string amount = "5000";
bool isProduction = true;
bool isCloudServer = false;
// Generate merchant token using provided JSON values
var builder = new MerchantTokenBuilder()
.SetTimeStamp(timestamp)
.SetIMid(clientId)
.SetTXid(tXid)
.SetAmount(amount)
.SetMerchantKey(merchantKey);
string merchantToken = builder.BuildMerchantToken();
Console.WriteLine("Create Merchant Token: " + merchantToken);
// Build Check Status request using JSON values
var Bodybuilder = new NicepayRequestBuilder()
.SetCheckStatus(
iMid: clientId,
timeStamp: timestamp,
tXid: tXid,
amt: amount,
referenceNo: refNo,
merchantToken: merchantToken
);
ApiEndpoints apiEndpoints = new ApiEndpoints();
Dictionary payload = Bodybuilder.Build();
string jsonPayload = Newtonsoft.Json.JsonConvert.SerializeObject(payload);
var checkStatusService = new NicepayRegistrationService(apiEndpoints, isProduction, isCloudServer);
var result = await checkStatusService.SendPostAsync(apiEndpoints.InquiryV2, payload);
```
Laravel
```php
protected $useProd = false;
protected $useCloud = false;
protected $inquiry_endpoint = "/nicepay/direct/v2/inquiry";
$url = HttpUtil::getNicepayDomain($this->useProd, $this->useCloud) . $this->inquiry_endpoint;
// Request body parameter from JSON
$timestamp = "20221214091282";
$txid = "IONPAYTEST01202212140949101366";
$reference_no = "ordNo20221214091293";
$amt = "5000";
$merchant_token = "7eceb5801db4e039223698c4eb9871432217132d8b0483122001a2569e8c7537";
$body = [
"timeStamp" => $timestamp,
"tXid" => $txid,
"iMid" => "IONPAYTEST",
"merchantToken" => $merchant_token,
"referenceNo" => $reference_no,
"amt" => $amt,
];
try {
$response = HttpUtil::postJsonRequest($url, $body);
} catch (\Exception $e) {
echo "Inquiry failed: " . $e->getMessage();
}
```
PHP Native
```php
$timeStamp = "20221214091282";
$txId = "IONPAYTEST01202212140949101366";
$iMid = "IONPAYTEST";
$referenceNo = "ordNo20221214091293";
$amount = "5000";
$config = $this->v2Config;
$parameter = InquiryStatus::builder()
->setTimeStamp($timeStamp)
->setTxId($txId)
->setIMid($iMid)
->setMerchantToken($timeStamp, $iMid, $referenceNo, $amount, $this->merchantKey)
->setReferenceNo($referenceNo)
->setAmt($amount)
->build();
$cardService = new V2CardService($config);
$response = $cardService->inquiryStatus($parameter);
```
```kotlin
val request: DirectV2CheckStatus = DirectV2CheckStatus.Builder()
.timeStamp("20221214091282")
.tXid("IONPAYTEST01202212140949101366")
.iMid("IONPAYTEST")
.merchantKey(DEFAULT_MERCHANT_KEY)
.referenceNo("ordNo20221214091293")
.amt("5000")
.build()
val response: NICEPayResponseV2 = v2CardService.checkStatus(request, config)!!
```
CodeIgniter
```php
$timeStamp = "20221214091282";
$reffNo = "ordNo20221214091293";
$amount = "5000";
$config = $this->v2Config;
$parameter = InquiryStatus::builder()
->setTimeStamp($timeStamp)
->setTxId("IONPAYTEST01202212140949101366")
->setIMid("IONPAYTEST")
->setMerchantToken($timeStamp, "IONPAYTEST", $reffNo, $amount, $this->merchantKey)
->setReferenceNo($reffNo)
->setAmt($amount)
->build();
$v2CardService = new V2CardService($config);
$response = $v2CardService->inquiryStatus($parameter);
```
:::
### Response Parameter
:::CodeblockTabs
Sample Response
```json
{
"tXid": "IONPAYTEST01202212140949101366",
"iMid": "IONPAYTEST",
"currency": "IDR",
"amt": "5000",
"instmntMon": "1",
"instmntType": "1",
"referenceNo": "ordNo20221214091293",
"goodsNm": "Goods",
"payMethod": "01",
"billingNm": "Hantu Kesorean",
"reqDt": "20221214",
"reqTm": "094910",
"status": "0",
"resultCd": "0000",
"resultMsg": "paid",
"cardNo": "453211*****1111",
"preauthToken": null,
"acquBankCd": "BMRI",
"issuBankCd": "OTHR",
"vacctValidDt": null,
"vacctValidTm": null,
"vacctNo": null,
"bankCd": null,
"payNo": null,
"mitraCd": null,
"receiptCode": null,
"cancelAmt": null,
"transDt": "20221214",
"transTm": "094910",
"recurringToken": null,
"ccTransType": "1",
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": "10",
"cardExpYymm": "2712",
"acquBankNm": "Mandiri",
"issuBankNm": "OTHER",
"depositDt": null,
"depositTm": null,
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null,
"authNo": "101366",
"acquirerData": {
"rrn": null
}
}
```
:::