Status Inquiry - API Checkout
About Status Inquiry - API Checkout
After you integrate successfully with NICEPAY Registration - API Checkout, your business is ready to do transactions in real with your Customer. However, NICEPAY recommend you to performs other API Checkout integration like this Inquiry API.
This API uses to check on transaction status you are requested on the previous Registration - API Checkout such as successful or failed transaction status.
When the transaction is completed, you will automatically get notification from us. NICEPAY strongly recommend you to re-check the transaction status using Status Inquiry - API Checkout.
Status Inquiry - API Checkout
API URL | /nicepay/direct/v2/inquiry |
|---|---|
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256 (timestamp+ iMid+ referenceNo+ amt+ merchantKey) |
When notification received to your dbProcessUrl, we strongly recommend Merchant to verify the Notification using Status Inquiry - API Checkout.
Notification Handling
Notification Handling is useful to minimalize Fraud actions, we strongly recommend Merchants to verify the Notification Handling.
Request Parameters for Status Inquiry - API Checkout
Parameter | Type | Size | Description | Remark |
|---|---|---|---|---|
timeStamp Required | N | 14 | API Request Date (YYYYMMDDHH24MISS) | 20221012080918 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST00202212191025073439 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
referenceNo Required | ANS | 40 | Merchant Order Number | ORDER20221012080918 |
amt Required | N | 12 | Transaction Amount | 10000 |
merchantToken Required | AN | 255 | Merchant Token | d8d0968892c568bc6ff5adc17cd755f85334a0b58fce85392682993a9ba653ed |
Response Parameters
Parameter | Type | Size | Description | Remark |
|---|---|---|---|---|
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | (empty) |
tXid | AN | 30 | Transaction ID | IONPAYTEST00202212191025073439 |
iMid | AN | 10 | Merchant ID | IONPAYTEST |
referenceNo | ANS | 40 | Merchant Order Number | ORDER20221012080918 |
payMethod | N | 2 | 00 | |
amt | N | 12 | Payment Amount | 10000 |
cancelAmt | N | 12 | Cancel Amount | null |
reqDt | N | 8 | Transaction Request Date (YYYYMMDD) | 20221219 |
reqTm | N | 6 | Transaction Request Time (HH24MISS) | 102507 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | null |
transTm | N | 6 | Transaction Time (HH24MISS) | null |
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 | null |
Additional - Credit Card
Parameter | Type | Size | Description | Remark |
|---|---|---|---|---|
authNo | N | 10 | Approval Number | |
issuBankCd | A | 4 | | |
acquBankCd | A | 4 | | |
acquBankNm | A | 255 | Acquiring Bank Name | |
issuBankNm | A | 255 | Issuing Bank Name | |
cardNo | ANS | 20 | Card Number ith Masking | |
cardExpYymm | N | 4 | Card Expiration (YYMM) | |
instmntMon | N | 2 | Installment Month 1: 1 Month/Full Payment, if instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months | |
instmntType | N | 2 | | |
preauthToken | AN | 255 | Pre-Auth Token (Needed for Capture Payment) | |
recurringToken | AN | 255 | Recurring Token (Needed for Recurring Payment ) | |
ccTransType | N | 2 | Credit Card Transaction Type | |
acquStatus | N | 2 | Purchase Status 1: Normal 2: Recurring 3: Pre-Auth 4: Capture | |
acquirerData | Array | 20 | A dynamic array consisting of a unique reference number RRN that is provided by the Banking 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" } |
vat | N | 12 | VAT | |
fee | N | 12 | Service Fee | |
notaxAmt | N | 12 | Tax-Fee Amount | |
Additional - Virtual Account
Parameter | Type | Size | Description | Remark |
|---|---|---|---|---|
bankCd | A | 4 | | |
vacctNo | N | 16 | Bank Virtual Account Number | |
vacctValidDt | N | 8 | VA Expiry date (YYYYMMDD) | |
vacctValidTm | N | 6 | VA Expiry time (HH24MISS) | |
Additional - Others for Status Inquiry - API Checkout
Parameter | Type | Size | Description | Remark |
|---|---|---|---|---|
mitraCd | A | 4 | (CVS, Direct Debit, E-Wallet, Paylater) | |
payNo | N | 12 | CVS Number (CVS) | |
payValidDt | N | 8 | CVS Expiry Date (YYYYMMDD) (CVS) | |
payValidTm | N | 6 | CVS Expiry time (HH24MISS) (CVS) | |
receiptCode | ANS | 20 | Authorization Code (CVS) | |
mRefNo | AN | 20 | Bank Reference Number (Direct Debit) | |
Sample Parameter for Status Inquiry- API Checkout
Request Parameter for Status Inquiry - API Checkout
$iMidTest = "IONPAYTEST";
$this->merchantKey = $testConst::IMID_COMMON_MERCHANT_KEY;
$this->v2Config = NICEPay::builder()
->setIsProduction(false)
->build();
$timeStamp = "20251111021168";
$reffNo = "ordNo20251111021198";
$amount = "10000";
$config = $this->v2Config;
$parameter = InquiryStatus::builder()
->setTimeStamp($timeStamp)
->setTxId("IONPAYTEST02202511110206549179")
->setIMid($this->iMidTest)
->setMerchantToken($timeStamp, $this->iMidTest, $reffNo, $amount, $this->merchantKey)
->setReferenceNo($reffNo)
->setAmt($amount)
->build();
try {
$v2VaService = new V2VAService($config); // You can use chosen payment method service
$response = $v2VaService->inquiryStatus($parameter);
} catch (Exception $e) {
}Response Parameter
{
"tXid": "IONPAYTEST02202511110206549179",
"iMid": "IONPAYTEST",
"currency": "IDR",
"amt": "10000",
"instmntMon": null,
"instmntType": "1",
"referenceNo": "ordNo20251111021198",
"goodsNm": "Goods",
"payMethod": "02",
"billingNm": "Hantu Kesorean",
"reqDt": "20251111",
"reqTm": "020654",
"status": "0",
"resultCd": "0000",
"resultMsg": "paid",
"cardNo": null,
"preauthToken": null,
"acquBankCd": null,
"issuBankCd": null,
"vacctValidDt": "20280128",
"vacctValidTm": "235959",
"vacctNo": "7812001000000605",
"bankCd": "IBBK",
"payNo": null,
"mitraCd": null,
"receiptCode": null,
"cancelAmt": null,
"transDt": "20251111",
"transTm": "020654",
"recurringToken": null,
"ccTransType": null,
"payValidDt": null,
"payValidTm": null,
"mRefNo": null,
"acquStatus": null,
"cardExpYymm": null,
"acquBankNm": null,
"issuBankNm": null,
"depositDt": "20251111",
"depositTm": "020705",
"paymentExpDt": null,
"paymentExpTm": null,
"paymentTrxSn": null,
"cancelTrxSn": null,
"userId": null,
"shopId": null
}