Cancel - API QRIS

13min

About API QRIS Cancel
﻿
This 
﻿ uses to cancel a 
﻿ that has been paid. If 
﻿ 
﻿ cancels before 
﻿ settlement 
﻿ is complete, 
﻿ 
﻿ is considered void, and 
﻿ 
﻿ funds will return to 
﻿ 
﻿.
﻿
API QRIS Cancel
﻿
The 
﻿ Cancel 
﻿ uses for 
﻿ cancel 
﻿ for 
﻿s via 
﻿.
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               
﻿
﻿
02               
﻿﻿
﻿
03               
﻿ 
﻿
04               
﻿ 
﻿
05               
﻿ 
﻿
06               
﻿ 
﻿
08               QRIS﻿
﻿
09               
﻿ 
﻿
﻿
Request Parameters for QRIS Cancel
﻿
The following is a list of 
﻿s for requesting 
﻿ of 
﻿ cancel 
﻿ 
﻿ on 
﻿ 
﻿ 
﻿. These 
﻿s are used via 
﻿ 
﻿ 
﻿ platform.
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required﻿
N
14
﻿
﻿ Request Timestamp 
﻿
20221208091279
tXid
﻿Required

AN
30
Transaction ID
IONPAYTEST08202212080951090538
iMid
﻿Required

AN
10
﻿
﻿ ID
IONPAYTEST
payMethod
﻿Required

N
2
﻿Payment Method Code﻿﻿
08
cancelType
﻿Required

N
2
﻿Cancel Type Code﻿ 
1
merchantToken
﻿Required

AN
255
﻿
﻿ Token 
﻿
4f875d8ea982affbf29b11cf0d3811918dcd4400298eccadb929711d1f6f24d6
amt
﻿Required

N
12
﻿
﻿ Amount 
﻿
5
cancelMsg
AN
255
Cancel Message
Request Cancel

cancelServerIp
AN
15
Server IP
﻿
cancelUserId
AN
30
User ID
admin
cancelUserIp
AN
15
User IP

cancelUserInfo
AN
100
User Information
Request Cancel
cancelRetryCnt	
N
2
Retry Count
﻿
worker
AN
10
Worker
﻿
﻿ 
﻿
Response Parameter for QRIS Cancel
﻿
Following are 
﻿ response 
﻿s from 
﻿ results of 
﻿ request 
﻿s for canceling 
﻿ handling:
Parameter
Type
Size
Description
Example / Notes
resultCd
N
4
﻿Result Code﻿ 
﻿
0000
resultMsg
AN
255
Result Message:
﻿Error Code﻿
 
SUCCESS
tXid
AN
30
Transaction ID
IONPAYTEST08202212080951090538
referenceNo
ANS
40
﻿
﻿ Order Number
ORD54321
transDt
N
8
Transaction Date
20221208
transTm
N
6
Transaction Time
095155
amt
N
12
Amount
5
﻿
Sample JSON for QRIS Cancel
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "IONPAYTEST08202212080951090538",
    "referenceNo": "ORD54321",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20221208",
    "transTm": "095155",
    "amt": "5"
}
{
    "tXid": "IONPAYTEST08202212080951090538",
    "referenceNo": "ORD54321",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20221208",
    "transTm": "095155",
    "amt": "5"
}
﻿
﻿

API End Point	/nicepay/direct/v2/cancel
Request Method	POST
Header	Content-Type: application/json
Merchant Token	SHA256(timeStamp+iMid+tXid+amt+merchantKey)

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Timestamp	20221208091279
tXid Required	AN	30	Transaction ID	IONPAYTEST08202212080951090538
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	08
cancelType Required	N	2	Cancel Type Code	1
merchantToken Required	AN	255	Token	4f875d8ea982affbf29b11cf0d3811918dcd4400298eccadb929711d1f6f24d6
amt Required	N	12	Amount	5
cancelMsg	AN	255	Cancel Message	Request Cancel
cancelServerIp	AN	15	Server IP
cancelUserId	AN	30	User ID	admin
cancelUserIp	AN	15	User IP
cancelUserInfo	AN	100	User Information	Request Cancel
cancelRetryCnt	N	2	Retry Count
worker	AN	10	Worker

Parameter	Type	Size	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	IONPAYTEST08202212080951090538
referenceNo	ANS	40	Order Number	ORD54321
transDt	N	8	Transaction Date	20221208
transTm	N	6	Transaction Time	095155
amt	N	12	Amount	5

Updated 18 Sep 2024

Did this page help you?

Notification - API QRIS

Change Log

Cancel - API QRIS

About API QRIS Cancel

API QRIS Cancel

Payment Methods Available for Cancel

Request Parameters for QRIS Cancel

Response Parameter for QRIS Cancel

Sample JSON for QRIS Cancel

Welcome to NICEPAY DOCS