Cancel - API GPN
API Cancel 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 ke Pelanggan Anda.
API GPN Cancel digunakan untuk membatalkan pembayaran GPN.
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 melakukan request integrasi proses cancel payment pada metode pembayaran GPN. Parameter ini digunakan melalui platform pengujian API .
Parameter | Tipe | Ukuran | Deskripsi | Contoh/Catatan |
timeStamp Required | N | 14 | API Request Timestamp | 20180123100505 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202103311759347262 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 09 | |
cancelType Required | N | 2 | Cancel Type | 1 |
merchantToken Required | AN | 255 | Merchant Token | 66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119 |
amt Required | N | 12 | Payment Amount | 10000 |
cancelMsg | AN | 255 | Cancel Message | Request Cancel |
preauthToken | AN | 100 | Pre-Auth Token | d4ef98b26f917a697691807cf |
referenceNo (Optional For CC) | ANS | 40 | Merchant Cancel No. | CancelNo20160525000-52104 |
cancelServerIp | AN | 15 | Server IP | 127.0.0.1 |
cancelUserId | AN | 30 | User ID | admin |
cancelUserIp | AN | 15 | User IP | 127.0.0.1 |
cancelUserInfo | AN | 100 | User Information | Test Cancel |
cancelRetryCnt | N | 2 | Retry Count | 3 |
worker | AN | 10 | Worker | |
Berikut adalah response parameter dari hasil request parameter untuk integrasi cancel GPN.
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 | IONPAYTEST01202103311759347262 |
referenceNo | ANS | 40 | Merchant Order No. | ord20210331170394 |
transDt | N | 8 | Transaction Date | 20210331 |
transTm | N | 6 | Transaction Time | 175934 |
amt | N | 12 | Amount | 1000 |
cancelReferenceNo (Optional For CC) | AN | 40 | Merchant Cancel No. | CancelNo20160525000-52104 |