Status Inquiry - API Paylater
Tentang API Paylater Status Inquiry
Integrasi API Status Inquiry pada Paylater digunakan oleh Merchant untuk 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 Paylater Status Inquiry
Integrasi status inquiry pada Paylater bertujuan supaya Merchant dapat terhubung dengan sistem API untuk melakukan pemeriksaan status pada metode pembayaran Paylater 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, NICEPAY sangat menganjurkan Merchant untuk melakukan verifikasi notifikasi tersebut dengan menggunakan Status Inquiry - API Paylater.
Notification Handling sangat berguna untuk meminimalisir terjadinya Fraud. Kami sangat menganjurkan Merchant untuk melakukan verifikasi Notification Handling. Anda dapat membaca informasi lebih rinci mengenai Notification Handling pada Notification - API Paylater.
Request Parameter for Paylater Status Inquiry
Berikut ini adalah daftar parameter untuk melakukan request status inquiry pada proses transaksi Paylater.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20221114114338 |
tXid Required | AN | 30 | Transaction ID | PAYLOANTES06202212051018325178 |
iMid Required | AN | 10 | Merchant ID | PAYLOANTES |
referenceNo Required | ANS | 40 | Merchant Order Number | ORD12345 |
amt Required | N | 12 | Transaction Amount | 10000 |
merchantToken Required | AN | 255 | Merchant Token | 3a04d0c8581ae37727f87130a0b32f2fe9fe39c66b88347352e7b90aeb5cb6e6 |
Response Parameter for Paylater Status Inquiry
Berikut ini adalah daftar response dari pengajuan status inquiry pada proses transaksi Paylater.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | init |
tXid | AN | 30 | Transaction ID | PAYLOANTES06202212051018325178 |
iMid | AN | 10 | Merchant ID | PAYLOANTES |
referenceNo | ANS | 40 | Merchant Reference Number | ORD12345 |
payMethod | N | 2 | 06 | |
amt | N | 12 | Payment Amount | 10000 |
CancelAmt | N | 12 | Cancel Amount | Null |
reqDt | N | 8 | Transaction Request Date (YYYYMMDD) | 20221205 |
reqTm | N | 6 | Transaction Request Time (HH24MISS) | 101832 |
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 | 9 | |
instmntMon | N | 2 | Installment Month | 1 |
instmntType | N | 2 | 2 | |
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 | VA Number | Null |
bankCd | A | 4 | Null | |
payNo | N | 12 | Payment Number | Null |
mitraCd | A | 4 | KDVI | |
receiptCode | ANS | 20 | Authorization Number | Null |
cancelAmt | N | 12 | Cancel Amount | Null |
recurringToken | AN | 255 | Recurring Token (Needed for Recurring Payment) | |
ccTransType | N | 2 | Null | |
payValidDt | N | 8 | CVS Expiry Date (YYYYMMDD) (CVS) | Null |
payValidTm | N | 6 | CVS Expiry Time (HH24MISS) (CVS) | Null |
mRefNo | AN | 20 | Bank Reference Number (Direct Debit) | Null |
acquStatus | N | 2 | Purchase Status 1: Normal 2: Recurring 3: Pre-Auth 4: Capture | Null |
cardExpYymm | N | 4 | Card Expiry (YYMM) | Null |
acquBankNm | A | 255 | Acquiring Bank Name | Null |
issuBankNm | A | 255 | Issuing Bank Name | Null |
paymentExpDt | N | 6 | QR Payment Expiry Date (YYYYMMDD) | Null |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) | Null |
cancelTrxSn | AN | 32 | Cancel Transaction Number | Null |
userId | AN | 128 | QRIS User ID Hash | Null |
shopId | AN | 32 | Shop ID | Null |
Additional Response Parameter for Paylater Status Inquiry
Berikut ini adalah informasi daftar response tambahan dari request status inquiry pada proses transaksi lainnya.
Parameter | Tipe | Ukuran | Deskripsi |
|---|---|---|---|
mitraCd | A | 4 | Mitra Code (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 JSON for Paylater Status Inquiry
{
"tXid": "PAYLOANTES06202212051018325178",
"iMid": "PAYLOANTES",
"currency": "IDR",
"amt": "10000",
"instmntMon": "1",
"instmntType": "2",
"referenceNo": "ORD12345",
"goodsNm": "Test Transaction Nicepay",
"payMethod": "06",
"billingNm": "John Doe",
"reqDt": "20221205",
"reqTm": "101832",
"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": "KDVI",
"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
}