Status Inquiry - API Direct Debit
Tentang API Direct Debit Status Inquiry
Integrasi API Status Inquiry pada Direct Debit 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.
API Direct Debit Status Inquiry
Integrasi status inquiry pada Direct Debit bertujuan supaya Merchant dapat terhubung dengan sistem API untuk melakukan pemeriksaan status pada metode pembayaran Direct Debit 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 Direct Debit.
Notification Handling sangat berguna untuk meminimalisir terjadinya Fraud. Kami sangat menganjurkan Merchant untuk melakukan verifikasi Notification Handling. Temukan informasi lebih rinci mengenai Notification Handling pada Notification - API Direct Debit.
Request Parameter for Direct Debit Status Inquiry
Berikut ini adalah daftar parameter untuk melakukan request status inquiry pada proses transaksi Direct Debit.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20220521144206 |
tXid Required | AN | 30 | Transaction ID | TNICECP04104202205191442060467 |
iMid Required | AN | 10 | Merchant ID | TNICECP041 |
referenceNo Required | ANS | 40 | Merchant Order Number | 20220519144204 |
amt Required | N | 12 | Transaction Amount | 2000 |
merchantToken Required | AN | 255 | Merchant Token | 415c63ed51b7fd1f8fb39b48138cd15d8edf301309b2330f7548970196a0073c |
Response Parameter for Direct Debit Status Inquiry
Berikut ini adalah daftar response dari request status inquiry pada proses transaksi Direct Debit.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | unpaid |
tXid | AN | 30 | Transaction ID | TNICECP04104202205191442060467 |
iMid | AN | 10 | Merchant ID | TNICECP041 |
referenceNo | ANS | 40 | Merchant Reference Number | 20220519144204 |
payMethod | N | 2 | 04 | |
amt | N | 12 | Payment Amount | 2000 |
CancelAmt | N | 12 | Cancel Amount | null |
reqDt | N | 8 | Transaction Request Date (YYYYMMDD) | 20220519 |
reqTm | N | 6 | Transaction Request Time (HH24MISS) | 144206 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | null |
transTm | N | 6 | Transction Time (HH24MISS) | null |
depositDt | N | 8 | Transaction Deposit Date (YYYYMMDD) | null |
depositTm | N | 6 | Transaction Deposit Time (HH24MISS) | null |
mitraCd | A | 4 | null | |
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) | null |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) | null |
vacctNo | N | 20 | Virtual Account No. | null |
bankCd | A | 4 | null | |
payNo | N | 12 | CVS Number (CVS) | null |
receiptCode | ANS | 20 | Authorization Number | 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 Number | 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) | null |
depositTm | N | 6 | Deposit Time (HH24MISS) | null |
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 |
billingNm | A | 100 | Buyer Name | John Doe |
status | N | 1 | 9 | |
userId | AN | 128 | QRIS User ID Hash | null |
shopId | AN | 32 | Shop ID | null |
Sample JSON for Direct Debit Status Inquiry
{
"tXid": "TNICECP04104202205191442060467",
"iMid": "TNICECP041",
"currency": "IDR",
"amt": "2000",
"instmntMon": null,
"instmntType": "1",
"referenceNo": "20220519144204",
"goodsNm": "Test Transaction",
"payMethod": "04",
"billingNm": "John Doe",
"reqDt": "20220519",
"reqTm": "144206",
"status": "9",
"resultCd": "0000",
"resultMsg": "init",
"cardNo": null,
"preauthToken": null,
"acquBankCd": null,
"issuBankCd": null,
"vacctValidDt": null,
"vacctValidTm": null,
"vacctNo": null,
"bankCd": null,
"payNo": null,
"mitraCd": null,
"receiptCode": null,
"cancelAmt": null,
"transDt": null,
"transTm": null,
"recurringToken": null,
"ccTransType": null,
"payValidDt": null,
"payValidTm": null,
"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
}