Cancel - API E-Wallet

13min

About API E-Wallet Cancel
﻿
This 
﻿ uses to cancel a 
﻿ that has been paid. If 
﻿ 
﻿ cancels before 
﻿ 
﻿ 
﻿ is complete, 
﻿ 
﻿ is considered void and 
﻿ 
﻿ funds will return to 
﻿ 
﻿.
﻿
API E-Wallet 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               E-Wallet﻿
﻿
06               
﻿ 
﻿
08               
﻿ 
﻿
09               
﻿ 
﻿
﻿
Request Parameters for E-Wallet 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 
﻿
20180123100505
tXid
 Required﻿
AN
30
Transaction ID
﻿

IONPAYTEST01202103311759347262
iMid
 Required﻿
AN
10
﻿
﻿ ID
﻿

IONPAYTEST
payMethod
 Required﻿
N
2
﻿Payment Method Code﻿ 

05
cancelType
 Required﻿
N
2
﻿Cancel Type Code﻿ 
﻿

1
merchantToken
 Required﻿
AN
255
﻿
﻿ Token 
﻿
﻿
66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119
amt
 Required﻿
N
12
﻿
﻿ Amount 
﻿

10000
cancelMsg
AN
255
Cancel Message
Request Cancel
cancelServerIp
AN
15
Server IP
127.0.0.1
﻿
Response Parameter for E-Wallet Cancel
﻿
Following are 
﻿ response 
﻿s from 
﻿ results of 
﻿ request 
﻿s for 
﻿ cancel 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
TNICEEW05105202212121343519502
referenceNo
ANS
40
﻿
﻿ Order Number
815123412341
transDt
N
8
Transaction Date
20221212
transTm
N
6
Transaction Time
W134351
description
AN
255
Description
test cancel
amt
N
12
Amount
1
﻿
Sample JSON for E-Wallet Cancel
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "TNICEEW05105202212121343519502",
    "referenceNo": "815123412341",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20221212",
    "transTm": "134351",
    "description": "test cancel",
    "amt": "1"
}
{
    "tXid": "TNICEEW05105202212121343519502",
    "referenceNo": "815123412341",
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "transDt": "20221212",
    "transTm": "134351",
    "description": "test cancel",
    "amt": "1"
}
﻿
﻿

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	20180123100505
tXid Required	AN	30	Transaction ID	IONPAYTEST01202103311759347262
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	05
cancelType Required	N	2	Cancel Type Code	1
merchantToken Required	AN	255	Token	66141d60572e570045c4f3e9965f3452d511496841981e8a2af6a24a7038a119
amt Required	N	12	Amount	10000
cancelMsg	AN	255	Cancel Message	Request Cancel
cancelServerIp	AN	15	Server IP	127.0.0.1

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	TNICEEW05105202212121343519502
referenceNo	ANS	40	Order Number	815123412341
transDt	N	8	Transaction Date	20221212
transTm	N	6	Transaction Time	W134351
description	AN	255	Description	test cancel
amt	N	12	Amount	1

Updated 18 Sep 2024

Did this page help you?

Notification - API E-Wallet

AstraPay Registration - API E-Wallet

Cancel - API E-Wallet

About API E-Wallet Cancel

API E-Wallet Cancel

Payment Methods Available for Cancel

Request Parameters for E-Wallet Cancel

Response Parameter for E-Wallet Cancel

Sample JSON for E-Wallet Cancel

Welcome to NICEPAY DOCS