Cancel - API Payout (Disbursement)

7min

About Cancel Payout (Disbursement)
﻿
﻿
﻿ to cancel 
﻿ 
﻿s that are already approved but before 
﻿ 
﻿ 
﻿ is running.
﻿
API Cancel Payout (Disbursement)
﻿
API Endpoint
/nicepay/api/direct/v2/cancelPayout
Request Method application/json﻿
﻿POST﻿
Header
Content-Type: application/json
Merchant Token
SHA256 (timeStamp + iMid + txid + merchantKey)
﻿
Request JSON for Payout (Disbursement) Cancel
﻿
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required﻿
N
14
﻿
﻿ Request Date
20221219235959
tXid
﻿Required﻿
AN
30
Transaction ID
IONPAYTEST07202212191748188703
iMid
﻿Required﻿
AN
10
﻿
﻿ ID
IONPAYTEST
merchantToken
﻿Required﻿
AN
255
﻿
﻿ Token
bae24edba7badd731c4bca1acd0609377581cd91a47d18d3c24a3c47256161e8
﻿
Response JSON for Payout (Disbursement) Cancel
﻿
Parameter
Type
Size
Description
Example / Notes
tXid
AN
30
Transaction ID
IONPAYTEST07202212191748188703
iMid
AN
10
﻿
﻿ ID
IONPAYTEST
referenceNo
ANS
40
﻿
﻿ Order Number
ORD12345
resultCd
N
4
﻿Result Code﻿ 
0000
resultMsg
AN
255
Result Message: Error Code﻿﻿
SUCCESS
transDt
N
8
Transaction Date
null
transTm
N
6
Transaction Time
null
accountNo
N
20
Beneficiary Account Number
5345000060
amt
N
12
Amount
10000
bankCd
A
4
﻿Bank Code﻿﻿
BDIN
benefNm
AN
40
Beneficiary Name
PT IONPAY NETWORKS
﻿
JSON Sample for Payout (Disbursement) Cancel
﻿
JSON Request
JSON Response
Java Request
{
    "resultCd": "0000",
    "benefNm": "PT IONPAY NETWORKS",
    "transTm": null,
    "referenceNo": "ORD12345",
    "accountNo": "5345000060",
    "bankCd": "BDIN",
    "tXid": "IONPAYTEST07202212191748188703",
    "amt": "10000",
    "transDt": null,
    "resultMsg": "SUCCESS",
    "iMid": "IONPAYTEST"
}
{
    "resultCd": "0000",
    "benefNm": "PT IONPAY NETWORKS",
    "transTm": null,
    "referenceNo": "ORD12345",
    "accountNo": "5345000060",
    "bankCd": "BDIN",
    "tXid": "IONPAYTEST07202212191748188703",
    "amt": "10000",
    "transDt": null,
    "resultMsg": "SUCCESS",
    "iMid": "IONPAYTEST"
}
﻿
﻿

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

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Date	20221219235959
tXid Required	AN	30	Transaction ID	IONPAYTEST07202212191748188703
iMid Required	AN	10	ID	IONPAYTEST
merchantToken Required	AN	255	Token	bae24edba7badd731c4bca1acd0609377581cd91a47d18d3c24a3c47256161e8

Parameter	Type	Size	Description	Example / Notes
tXid	AN	30	Transaction ID	IONPAYTEST07202212191748188703
iMid	AN	10	ID	IONPAYTEST
referenceNo	ANS	40	Order Number	ORD12345
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
transDt	N	8	Transaction Date	null
transTm	N	6	Transaction Time	null
accountNo	N	20	Beneficiary Account Number	5345000060
amt	N	12	Amount	10000
bankCd	A	4	Bank Code	BDIN
benefNm	AN	40	Beneficiary Name	PT IONPAY NETWORKS

Updated 02 Oct 2024

Did this page help you?

Inquiry - API Payout (Disbursement)

Notification - API Payout (Disbursement)

Cancel - API Payout (Disbursement)

About Cancel Payout (Disbursement)

API Cancel Payout (Disbursement)

Request JSON for Payout (Disbursement) Cancel

Response JSON for Payout (Disbursement) Cancel

JSON Sample for Payout (Disbursement) Cancel

Welcome to NICEPAY DOCS