Inquiry - API Payout (Disbursement)

7min

About Payout (Disbursement) Inquiry 
﻿
This 
﻿ uses by 
﻿s to check 
﻿ 
﻿ of 
﻿ 
﻿s with 
﻿ 
﻿ success, fail, and others.
﻿
API Payout (Disbursement) Inquiry 
﻿
API Endpoint
/nicepay/api/direct/v2/inquiryPayout
Request Method 
﻿POST﻿
Header
Content-Type: application/json
Merchant Token
SHA256 (timeStamp + iMid + tXid+ accountNo + merchantKey)
﻿
Request JSON for Payout Inquiry
﻿
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required﻿
N
14
﻿
﻿ Request Date
20221219085959
tXid
﻿Required﻿
AN
30
Transaction ID
IONPAYTEST07202212191238107952
iMid
﻿Required﻿
AN
10
﻿
﻿ ID
IONPAYTEST
accountNo
﻿Required﻿
N
20
Beneficiary Account Number
5345000060
merchantToken
﻿Required﻿
AN
255
﻿
﻿ Token
9fd6e4088eb01d9ff93c9f5799bd3e6995f66990793e0e67ac0f651bc2a6fa78
﻿
Response JSON for Payout Inquiry
﻿
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 (Key from 
﻿)
IONPAYTEST07202212191238107952
iMid
AN
10
﻿
﻿ ID
IONPAYTEST
accountNo
N
20
Beneficiary Account Number
5345000060
amt
N
12
﻿
﻿ Amount
10000
benefType
N
2
Beneficiary Type
1: Personal
2: Company
3: Government
1
bankCd
A
4
﻿Bank Code﻿ 
BDIN
referenceNo
ANS
20
﻿
﻿ Order Number (Key from 
﻿)
ORD12345
status
N
1
Transaction Status
0: Approved 
3: Request
4: Cancel
8: Timeout
9: Failed
5: Reject before Approved
0
﻿
reqDt
N
8
Transaction Request Date (YYYYMMDD)
20221219
reqTm
N
6
Transaction Request Time (HH24MISS)
123810
transDt
N
8
Transaction Date (YYYYMMDD)
20221219
transTm
N
6
Transaction Time (HH24MISS)
124824
benefStatus
N
2
Beneficiary Status: 
1: WNI
2: WNA
1
benefId
AN
100
Beneficiary ID
null
benefNm
AN
40
Beneficiary Name
PT IONPAY NETWORKS
﻿
JSON Sample for Payout Inquiry
﻿
JSON Request
JSON Response
Java Request
{
    "reqTm": "123810",
    "resultCd": "0000",
    "transTm": "124824",
    "referenceNo": "ORD12345",
    "tXid": "IONPAYTEST07202212191238107952",
    "amt": "10000",
    "benefStatus": "1",
    "resultMsg": "SUCCESS",
    "iMid": "IONPAYTEST",
    "benefNm": "PT IONPAY NETWORKS",
    "benefType": "1",
    "accountNo": "5345000060",
    "bankCd": "BDIN",
    "reqDt": "20221219",
    "transDt": "20221219",
    "benefId": null,
    "status": "0"
}
{
    "reqTm": "123810",
    "resultCd": "0000",
    "transTm": "124824",
    "referenceNo": "ORD12345",
    "tXid": "IONPAYTEST07202212191238107952",
    "amt": "10000",
    "benefStatus": "1",
    "resultMsg": "SUCCESS",
    "iMid": "IONPAYTEST",
    "benefNm": "PT IONPAY NETWORKS",
    "benefType": "1",
    "accountNo": "5345000060",
    "bankCd": "BDIN",
    "reqDt": "20221219",
    "transDt": "20221219",
    "benefId": null,
    "status": "0"
}
﻿
﻿

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

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Date	20221219085959
tXid Required	AN	30	Transaction ID	IONPAYTEST07202212191238107952
iMid Required	AN	10	ID	IONPAYTEST
accountNo Required	N	20	Beneficiary Account Number	5345000060
merchantToken Required	AN	255	Token	9fd6e4088eb01d9ff93c9f5799bd3e6995f66990793e0e67ac0f651bc2a6fa78

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 (Key from )	IONPAYTEST07202212191238107952
iMid	AN	10	ID	IONPAYTEST
accountNo	N	20	Beneficiary Account Number	5345000060
amt	N	12	Amount	10000
benefType	N	2	Beneficiary Type 1: Personal 2: Company 3: Government	1
bankCd	A	4	Bank Code	BDIN
referenceNo	ANS	20	Order Number (Key from )	ORD12345
status	N	1	Transaction Status 0: Approved 3: Request 4: Cancel 8: Timeout 9: Failed 5: Reject before Approved	0
reqDt	N	8	Transaction Request Date (YYYYMMDD)	20221219
reqTm	N	6	Transaction Request Time (HH24MISS)	123810
transDt	N	8	Transaction Date (YYYYMMDD)	20221219
transTm	N	6	Transaction Time (HH24MISS)	124824
benefStatus	N	2	Beneficiary Status: 1: WNI 2: WNA	1
benefId	AN	100	Beneficiary ID	null
benefNm	AN	40	Beneficiary Name	PT IONPAY NETWORKS

Updated 02 Oct 2024

Did this page help you?

Reject - API Payout (Disbursement)

Cancel - API Payout (Disbursement)

Inquiry - API Payout (Disbursement)

About Payout (Disbursement) Inquiry

API Payout (Disbursement) Inquiry

Request JSON for Payout Inquiry

Response JSON for Payout Inquiry

JSON Sample for Payout Inquiry

Welcome to NICEPAY DOCS