Status Inquiry - API Checkout
Tentang Status Inquiry - API Checkout
Setelah Anda sukses melakukan integrasi dengan Registration - API Checkout NICEPAY, bisnis Anda siap untuk melakukan transaksi secara real dengan Pelanggan Anda. Namun, NICEPAY rekomendasikan Anda melakukan integrasi API Checkout lainnya seperti Inquiry API ini.
API ini digunakan untuk memeriksa status transaksi yang Anda ajukan pada Registration - API Checkout sebelumnya seperti berhasil atau gagal status transaksinya.
Ketika transaksi sudah selesai dilakukan, Anda akan menerima notifikasi secara otomatis dari kami, NICEPAY sangat merekomendasikan Anda untuk memeriksa status transaksi kembali tersebut dengan menggunakan 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) |
Ketika notifikasi diterima oleh dbProcessUrl Anda, kami sangat merekomendasikan Merchant untuk melakukan verifikasi notifikasi dengan menggunakan Status Inquiry - API Checkout.
Notification Handling
Notification Handling berguna untuk meminimalisir aksi penipuan, kami sangat merekomendasikan para Merchant untuk melakukan verifikasi Notification Handling.
Request Parameters for Status Inquiry - API Checkout
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
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 for Status Inquiry - API Checkout
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
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 | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
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 with Masking | |
cardExpYymm | N | 4 | Card Expiration (YYMM) | |
instmntMon | N | 2 | Installment Month 1: 1 Month/Full Payment, jika 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 | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
bankCd | A | 4 | Bank Code | |
vacctNo | N | 16 | Bank Virtual Account Number | |
vacctValidDt | N | 8 | VA Expiry date (YYYYMMDD) | |
vacctValidTm | N | 6 | VA Expiry time (HH24MISS) | |
Additional - Others
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
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
const SecondApiVersion = require("../lib/secondApiVersion.js");
const cons = require("./sharedConfig.js");
const config = {
isProduction: false,
isCloudServer: false,
merchantKey: cons.merchantKey,
};
const parameter = {
"timeStamp": "20251111021168",
"iMid": "IONPAYTEST",
"tXid": "IONPAYTEST02202511110206549179",
"referenceNo": "ordNo20251111021198",
"amt": "10000"
};
let secondVersion = new SecondApiVersion(config);
let response = secondVersion
.requestAPI(parameter, "/direct/v2/inquiry");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
}