Status Inquiry - API Virtual Account
Integrasi API Status Inquiry pada Virtual Account diperlukan supaya Merchant dapat memeriksa status yang berlangsung pada proses transaksi yang dilakukan oleh Pelanggan baik berstatus success, fail, dan lainnya. Sehingga sistem dapat memiliki laporan mengenai informasi tersebut.
Integrasi status inquiry pada Virtual Account bertujuan supaya Merchant dapat terhubung dengan sistem API untuk melakukan pengecekan status pada metode pembayaran Virtual Account secara berkala.
API End Point | /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 |
Ketika notifikasi diterima dbProcessUrl Anda, kami sangat menyarankan Merchant untuk melakukan verifikasi notifikasi tersebut dengan menggunakan Status Inquiry - API Virtual Account.
Ketika notifikasi diterima pada dbProcessUrl Anda, kami sangat menyarankan kepada Merchant untuk melakukan verifikasi notifikasi kembali dengan menggunakan Notification - API Virtual Account.
Berikut ini adalah daftar parameter untuk melakukan request status inquiry pada proses transaksi Virtual Account.
Parameter | Tipe | Ukuran | Deskripsi | Contoh |
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 |
Berikut ini adalah daftar response dari request status inquiry pada proses transaksi Virtual Account.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
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 |
Berikut ini adalah informasi daftar response tambahan dari request status inquiry pada proses transaksi Virtual Account.
Parameter | Tipe | Ukuran | Deskripsi |
bankCd | A | 4 | |
vacctNo | N | 16 | Bank Virtual Account Number |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) |
vacctValidTm | N | 9 | VA Expiry Time (HH24MISS) |