Status Inquiry - API Convenience Store
Tentang API Convenience Store Status Inquiry
API Status Inquiry untuk Convenience Store diperlukan untuk Merchant untuk memeriksa kembali status proses transaksi yang dilakukan Pelanggan, baik berstatus success, fail, dan lainnya. Sehingga, sistem mendapatkan laporan mengenai status atau informasi transaksi tersebut.
API Convenience Store Status Inquiry
API Status Inquiry pada Convenience Store bertujuan untuk Merchant dapat terhubung dengan sistem API yang digunakan untuk melakukan pemeriksaan status metode pembayaran Convenience Store secara berkala.
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 |
Ketika notifikasi diterima dbProcessUrl Anda, kami sangat menganjurkan Merchant untuk melakukan verifikasi notifikasi tersebut dengan menggunakan Status Inquiry - API Convenience Store.
Notification Handling sangat berguna untuk meminimalisir terjadinya Fraud. Kami sangat menganjurkan Merchant untuk melakukan verifikasi Notification Handling melalui Notification - API Convenience Store.
Request Parameter for Convenience Store Status Inquiry
Berikut ini adalah daftar parameter untuk melakukan request status inquiry pada proses transaksi Convenience Store.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20170708123456 |
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
Berikut ini adalah daftar response dari request status inquiry pada proses transaksi Convenience Store.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | unpaid |
tXid | AN | 30 | Transaction ID | IONPAYTEST00202212091011228108 |
iMid | AN | 10 | Merchant ID | IONPAYTEST |
referenceNo | ANS | 40 | Merchant Reference Number | ORDER20221012080918 |
payMethod | N | 2 | 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 | 3 |
Additional Response Parameter for Others Status Inquiry
Berikut ini adalah informasi daftar respon tambahan dari request status inquiry pada proses transaksi lainnya.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
mitraCd | A | 4 | Mitra Code (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
{
"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
}