Cancel - API Convenience Store
API Convenience Store Cancel ini digunakan untuk mengintegrasikan cancel atau pembatalan pembayaran pada metode pembayaran Convenience Store yang digunakan oleh Merchant. 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 nomor pembayaran yang sudah terbit tidak bisa digunakan.
Nomor pembayaran 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 Cancel Convenience Store digunakan untuk sistem cancel melalui metode Convenience Store.
API End Point | /nicepay/direct/v2/cancel |
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256(timeStamp+iMid+tXid+amt+merchantKey) |
Request Format | application/json |
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 cancel pada metode pembayaran Convenience Store. Parameter ini digunakan melalui platform pengujian API.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
timeStamp Required | N | 14 | API Request Timestamp | 20221212101278 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST03202212121030529316 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 03 | |
cancelType Required | N | 2 | | 1 |
cancelMsg | AN | 255 | Cancel Message | Request Cancel |
merchantToken Required | AN | 255 | Merchant Token | 49974dde3c4a311030bd2095431443ce3689d79c90caaa88f4186050abb77cf9 |
amt Required | N | 12 | Payment Amount | 10000 |
preauthToken | AN | 100 | Pre-Auth Token | - |
Berikut adalah response parameter dari hasil request parameter untuk integrasi Convenience Store 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 | IONPAYTEST03202212121030529316 |
referenceNo | ANS | 40 | Merchant Order No. | 815123412341 |
transDt | N | 8 | Transaction Date | 20221212 |
transTm | N | 6 | Transaction Time | 103052 |
description | AN | 255 | Description | test cancel |
amt | N | 12 | Amount | 10000 |