Cancel - API Virtual Account
API ini digunakan Merchant untuk mengintegrasikan sistem pembatalan pada metode pembayaran Virtual Account. Pembatalan transaksi dapat terjadi baik dari sisi Pelanggan maupun Merchant.
- Jika Pelanggan berubah pikiran setelah melakukan suatu pemesanan dan mengajukan pembatalan kepada Merchant sebelum melakukan proses pembayaran.
- Jika pada saat Merchant melakukan proses pada pesanan Pelanggan terjadi kendala baik teknis maupun non-teknis.
Merchant dapat menggunakan API ini agar Virtual Account yang sudah terbit tidak bisa digunakan.
Nomor Virtual Account yang sudah dibuat hanya dapat dibatalkan sebelum proses pembayaran berlangsung via API.
Apabila Pelanggan sudah melakukan proses pembayaran, tagihan yang sudah dibayarkan tidak bisa dibatalkan atau dilakukan pengembalian dana pada Pelanggan melalui API.
API Virtual Account Cancel digunakan untuk melakukan pembatalan pada Nomor Virtual Account.
API Endpoint | /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 mengaktifkan sistem pembatalan pada metode pembayaran Virtual Account. Parameter ini digunakan melalui platform pengujian API.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
timeStamp Required | N | 14 | Date | 20220623100659 |
tXid Required | AN | 30 | Transaction ID | NORMALTEST02202212150941111979 |
iMid Required | AN | 10 | Merchant ID | NORMALTEST |
payMethod Required | N | 2 | 02 | |
cancelType Required | N | 2 | | 1 |
merchantToken Required | AN | 255 | Merchant Token | 94acd9768557df77de675b7b97658d6a743cc0675f4eb681c871c4e1b56c0b0f |
amt Required | N | 12 | Payment Amount | 10000 |
cancelMsg | AN | 255 | Cancel Message | Testing Cancel Of Virtual Account |
cancelServerIp | AN | 15 | Server IP | 127.0.0.1 |
cancelUserId | AN | 30 | User ID | |
cancelUserIp | AN | 15 | User IP | 127.0.0.1 |
cancelUserInfo | AN | 100 | User Information |
|
cancelRetryCnt | N | 2 | Retry Count | |
worker | AN | 10 | Worker | |
Berikut adalah response parameter dari hasil request parameter untuk integrasi Virtual Account Cancel:
Parameter | Tipe | Ukuran | Deskripsi | Contoh/ Catatan |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | NORMALTEST02202212150941111979 When Success |
referenceNo | ANS | 40 | Merchant Order No. | ordNo20221215091261 When Success |
transDt | N | 8 | Transaction Date | 20221215 When Success |
transTm | N | 6 | Transaction Time | 094111 When Success |
description | AN | 255 | Description | Testing Cancel Of Virtual Account When Success |
amt | N | 12 | Amount | 10000 When Success |