Cancel - API QRIS
API ini digunakan untuk membatalkan transaksi yang sudah dibayarkan. Jika transaksi dibatalkan sebelum proses Settlement selesai, maka transaksi tersebut dianggap void dan dana transaksi tersebut akan dikembalikan kepada Pelanggan.
API QRIS Cancel digunakan untuk melakukan pembatalan pada pembayaran melalui QRIS.
API End Point | /nicepay/direct/v2/cancel |
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256(timeStamp+iMid+tXid+amt+merchantKey) |
Code PayMethod
01 Credit Card
02 Virtual Account
03 Convenience Store
04 Direct Debit
05 E-Wallet
06 Payloan
08 QRIS
09 GPN
Berikut ini adalah daftar parameter untuk melakukan request integrasi proses cancel payment pada metode pembayaran QRIS. Parameter ini digunakan melalui platform pengujian API .
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
timeStamp Required | N | 14 | API Request Timestamp | 20221208091279 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST08202212080951090538 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 08 | |
cancelType Required | N | 2 | 1 | |
merchantToken Required | AN | 255 | Merchant Token | 4f875d8ea982affbf29b11cf0d3811918dcd4400298eccadb929711d1f6f24d6 |
amt Required | N | 12 | Payment Amount | 5 |
cancelMsg | AN | 255 | Cancel Message | Request Cancel |
cancelServerIp | AN | 15 | Server IP | |
cancelUserId | AN | 30 | User ID | admin |
cancelUserIp | AN | 15 | User IP |
|
cancelUserInfo | AN | 100 | User Information | Request Cancel |
cancelRetryCnt | N | 2 | Retry Count | |
worker | AN | 10 | Worker | nicepay |
Berikut adalah response parameter dari hasil request parameter untuk cancel handling QRIS.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | Result Message: | Success |
tXid | AN | 30 | Transaction ID | IONPAYTEST08202212080951090538 |
referenceNo | ANS | 40 | Merchant Order No. | ORD54321 |
transDt | N | 8 | Transaction Date | 20221208 |
transTm | N | 6 | Transaction Time | 095155 |
amt | N | 12 | Amount | 5 |