Cancel - API Credit Card
Tentang Cancel - API Credit Card
API ini digunakan oleh Merchant untuk membatalkan transaksi yang sudah dibayarkan.
Jika Anda membatalkan sebelum proses Settlement selesai, maka transaksi tersebut dianggap Void dan dana transaksi tersebut akan dikembalikan ke Pelanggan Anda. Namun, pembatalan setelah proses Settlement selesai, maka masuk dalam kategori Refund.
Silakan untuk membuka halaman Penyelesaian Transaksi Pada Kartu Kredit untuk mengetahui lebih lanjut mengenai istilah Void maupun Refund.
Cancel - API Credit Card
API Credit Card Cancel digunakan untuk membatalkan proses pada pembayaran melalui Kartu Kredit.
API Endpoint | /nicepay/direct/v2/cancel |
|---|---|
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256(timeStamp+iMid+tXid+amt+merchantKey) |
Request Parameters for Cancel - API Credit Card
Berikut ini adalah daftar parameter untuk melakukan request integrasi proses cancel payment pada metode pembayaran Kartu Kredit. Parameter ini digunakan melalui platform pengujian API.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
|---|---|---|---|---|
timeStamp Required | N | 14 | API Request Timestamp | 20221214111239 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202212141146401456 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 01 | |
cancelType Required | N | 2 | | 2 |
merchantToken Required | AN | 255 | Merchant Token | ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae |
referenceNo | ANS | 40 | Reference Number | ordNo20221214111208 |
amt Required | N | 12 | Payment Amount | 1000 |
cancelMsg | AN | 255 | Cancel Message | Cancellation Of Transaction Credit Card |
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 | 5 |
worker | AN | 10 | Worker | Worker |
Response Parameter for Cancel - API Credit Card
Berikut adalah response parameter dari hasil request parameter untuk cancel handling Kartu Kredit:
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 | IONPAYTEST01202212141146401456 |
referenceNo | ANS | 40 | Merchant Order Number | ordNo20221214111208 |
transDt | N | 8 | Transaction Date | 20221214 |
transTm | N | 6 | Transaction Time | 114640 |
amt | N | 12 | Amount | 5000 |
cancelReferenceNo Optional For CC | AN | 40 | Merchant Cancel Number | ordNo20221214111208 |
acquirerData Only For CC | Array | 20 | A dynamic array consisting of a unique reference number RRN that is provided by the Banking Partner when a refund is processed. This reference number can be used by the Customer to track the status of the refund with the Bank. | "acquirerData": { "rrn":"332608321717" } |
Sample Parameter for Cancel - API Credit Card
Request Parameter
const config = {
isProduction: false,
privateKey: cons.privateKey,
clientSecret: cons.clientSecret,
clientId: cons.clientId,
isCloudServer: false,
merchantKey: cons.merchantKey,
};
let parameterCancel = {
timeStamp: "20251008131011",
payMethod: "01",
tXid: "IONPAYTEST01202509241944339756",
iMid: "IONPAYTEST",
merchantToken: "45505e04460a30418c425506e6b53295cc548b7ec11dd6685b0bf669e26c8db6",
referenceNo: "OrdNo20250924194433",
amt: "10000",
cancelType: "2",
cancelMsg: "Cancellation Of Transaction",
cancelServerIp: "127.0.0.1",
cancelUserId: "",
cancelUserIp: "127.0.0.1",
cancelUserInfo: "",
cancelRetryCnt: "",
worker: "",
};
let secondVersion = new SecondApiVersion(config);
response = secondVersion.requestAPI(parameterCancel, "/direct/v2/cancel");
Response Parameter
{
"tXid": "IONPAYTEST01202509241944339756",
"referenceNo": "OrdNo20250924194433",
"resultCd": "0000",
"resultMsg": "SUCCESS",
"transDt": "20250924",
"transTm": "194433",
"description": "This is testing transaction",
"amt": "10000",
"cancelReferenceNo": "OrdNo20250924194433",
"acquirerData": {
"rrn": null
}
}