Cancel - API GPN

13min

Tentang API GPN Cancel
﻿
﻿
﻿ Cancel ini digunakan untuk membatalkan 
﻿ 
﻿ sudah dibayarkan. Jika 
﻿ dibatalkan sebelum 
﻿ 
﻿ selesai, maka 
﻿ tersebut dianggap void dan dana 
﻿ tersebut akan dikembalikan ke 
﻿ 
﻿.
﻿
API GPN Cancel
﻿
﻿
﻿ 
﻿ Cancel digunakan untuk membatalkan 
﻿ 
﻿.
API Endpoint
/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               
﻿ 
﻿
09               GPN﻿
﻿
﻿
Request Parameters for GPN Cancel
﻿
Berikut ini adalah daftar 
﻿ untuk melakukan request 
﻿ 
﻿ cancel payment pada 
﻿ 
﻿. Parameter ini digunakan melalui platform pengujian 
﻿ .  
Parameter
Tipe
Ukuran
Deskripsi
Contoh/Catatan
timeStamp
﻿Required

N
14
﻿
﻿ Request Timestamp 
20180123100505
tXid
﻿Required

AN
30
Transaction ID
IONPAYTEST01202103311759347262
iMid
﻿Required

AN
10
﻿
﻿ ID
IONPAYTEST
payMethod
﻿Required

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

N
2
Cancel Type 
1
merchantToken
﻿Required

AN
255
﻿
﻿ Token 
66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119
amt
﻿Required

N
12
﻿
﻿ Amount 
10000
cancelMsg
AN
255
Cancel Message
Request Cancel
preauthToken
AN
100
Pre-Auth Token
d4ef98b26f917a697691807cf
referenceNo
﻿(Optional For CC)﻿
ANS
40
﻿
﻿ Cancel Number
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
﻿
﻿
Response Parameter for GPN Cancel
﻿
Berikut adalah response parameter dari hasil request parameter untuk 
﻿ 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
IONPAYTEST01202103311759347262
referenceNo
ANS
40
﻿
﻿ Order Number
ord20210331170394
transDt
N
8
Transaction Date
20210331
transTm
N
6
Transaction Time
175934
amt
N
12
Amount
1000
cancelReferenceNo
﻿(Optional For CC)﻿
AN
40
﻿
﻿ Cancel Number
CancelNo20160525000-52104
﻿
Sample JSON for GPN Cancel
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "IONPAYTEST01202103311759347262",
    "referenceNo": "ord20210331170394",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20210331",
    "transTm": "175934",
    "amt": "10000",
    "cancelReferenceNo": "CancelNo20160525000-52104"
}
{
    "tXid": "IONPAYTEST01202103311759347262",
    "referenceNo": "ord20210331170394",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20210331",
    "transTm": "175934",
    "amt": "10000",
    "cancelReferenceNo": "CancelNo20160525000-52104"
}
﻿
﻿

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

Parameter	Tipe	Ukuran	Deskripsi	Contoh/Catatan
timeStamp Required	N	14	Request Timestamp	20180123100505
tXid Required	AN	30	Transaction ID	IONPAYTEST01202103311759347262
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	09
cancelType Required	N	2	Cancel Type	1
merchantToken Required	AN	255	Token	66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119
amt Required	N	12	Amount	10000
cancelMsg	AN	255	Cancel Message	Request Cancel
preauthToken	AN	100	Pre-Auth Token	d4ef98b26f917a697691807cf
referenceNo (Optional For CC)	ANS	40	Cancel Number	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

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	Order Number	ord20210331170394
transDt	N	8	Transaction Date	20210331
transTm	N	6	Transaction Time	175934
amt	N	12	Amount	1000
cancelReferenceNo (Optional For CC)	AN	40	Cancel Number	CancelNo20160525000-52104

Updated 18 Sep 2024

Did this page help you?

Notification - API GPN

API QRIS

Cancel - API GPN

Tentang API GPN Cancel

API GPN Cancel

Payment Methods Available for Cancel

Request Parameters for GPN Cancel

Response Parameter for GPN Cancel

Sample JSON for GPN Cancel

Selamat Datang di NICEPAY DOCS