Cancel - API Paylater
About API Paylater Cancel
This API uses to cancel a transaction that has been paid. If the transaction cancels before the settlement process is complete, the transaction is considered void, and the transaction funds will return to the Customer.
API Paylater Cancel
The Paylater Cancel API uses for the cancel system for payments via Paylater.
API End Point | /nicepay/direct/v2/cancel |
|---|---|
Request Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256(timeStamp+iMid+tXid+amt+merchantKey) |
Payment Methods Available for Cancel
Code PayMethod
01 Credit Card
02 Virtual Account
03 Convenience Store
04 Direct Debit
05 E-Wallet
06 Paylater
08 QRIS
09 GPN
Request Parameters for Paylater Cancel
The following is a list of parameters for requesting integration of the cancel payment process on the Paylater payment method. These parameters are used via the API testing platform.
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
timeStamp Required | N | 14 | API Request Timestamp | 20221213141266 |
tXid Required | AN | 30 | Transaction ID | PAYLOANTES00202212131410560896 |
iMid Required | AN | 10 | Merchant ID | PAYLOANTES |
payMethod Required | N | 2 | 06 | |
cancelType Required | N | 2 | | 1 |
cancelMsg | AN | 255 | Cancel Message | Request Cancel |
merchantToken Required | AN | 255 | Merchant token | 9d1835e8bf87b51b44de9b2455fa37e733a87b12644b9cd4546e2ec2de651863 |
amt Required | N | 12 | Payment Amount | 12000 |
cancelUserId | AN | 30 | User ID | admin |
Response Parameter for Paylater Cancel
Following are the response parameters from the results of the request parameters for canceling Paylater handling:
Parameter | Type | Size | Description | Example/Notes |
|---|---|---|---|---|
tXid | AN | 30 | Transaction ID | PAYLOANTES00202212131410560896 |
referenceNo | ANS | 40 | Merchant Order Number | ord20200910170911 |
transDt | N | 8 | Transaction Date | 20221213 |
transTm | N | 6 | Transaction Time | 141056 |
amt | N | 12 | Amount | 12000 |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
Sample JSON for Paylater Cancel
{
"timeStamp":"20221213141266",
"tXid":"PAYLOANTES00202212131410560896",
"iMid":"PAYLOANTES",
"payMethod":"06",
"cancelType":"1",
"cancelMsg":"Request Cancel",
"merchantToken":"9d1835e8bf87b51b44de9b2455fa37e733a87b12644b9cd4546e2ec2de651863",
"amt":"12000",
"cancelUserId":"admin"
}