Status Inquiry - API Direct Debit

8min

About API Direct Debit Status Inquiry
﻿
Integration of 
﻿ Status Inquiry 
﻿ on 
﻿ is required so that 
﻿s can check 
﻿ current 
﻿ of 
﻿ 
﻿ 
﻿ carried out by 
﻿ 
﻿ whether 
﻿ 
﻿ is success, fail, and others. So that 
﻿ 
﻿ can have a report on that 
﻿.
﻿
API Direct Debit Status Inquiry
﻿
The 
﻿ of Inquiry Status on 
﻿ aims to allow 
﻿s to connect with 
﻿ 
﻿ 
﻿ to check 
﻿ 
﻿ of 
﻿ 
﻿ 
﻿ on a regular basis.

API Endpoint
/nicepay/direct/v2/inquiry
Request Method
﻿POST﻿
Description
Performs Inquiry Request to 
﻿ for Status Checking
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format
application/json
When your dbProcessUrl received a 
﻿, 
﻿ strongly recommend 
﻿ to verify 
﻿ 
﻿ using 
﻿ Status Inquiry - API Direct Debit﻿.
Notification Handling  is very useful to minimize 
﻿ risk of Fraud. We strongly encourage 
﻿s to verify Notification Handling. You can read more detailed 
﻿ about Notification Handling on Notification - API Direct Debit﻿ 
﻿
Request Parameter for Direct Debit Status Inquiry
﻿
The following is a list of 
﻿s for requesting a 
﻿ inquiry in 
﻿ 
﻿ 
﻿ 
﻿.
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20220521144206
tXid
Required
﻿
AN
30
Transaction ID
TNICECP04104202205191442060467
iMid
﻿Required
﻿
AN
10
﻿
﻿ ID
TNICECP041
referenceNo
Required
﻿
ANS
40
﻿
﻿ Order Number
20220519144204
amt
Required
﻿
N
12
Transaction Amount	
2000
merchantToken
Required
﻿
AN
255
﻿
﻿ Token
415c63ed51b7fd1f8fb39b48138cd15d8edf301309b2330f7548970196a0073c
﻿
Response Parameter for Direct Debit Status Inquiry  
﻿
The following is a list of responses to request status inquiry on the Direct Debit transaction process.
Parameter
Type
Size
Description
Example / Notes
resultCd
N
4
﻿Result Code﻿ 
0000
resultMsg
AN
255
Result Message: Error Code﻿ 
unpaid
tXid
AN
30
Transaction ID
TNICECP04104202205191442060467
iMid
AN
10
﻿
﻿ ID
TNICECP041
referenceNo 
ANS
40
﻿
﻿ Reference Number
20220519144204
payMethod 
N
2
﻿Payment Method Code﻿ 
04
amt
N
12
﻿
﻿ Amount
2000
CancelAmt
N
12
Cancel amount
null
reqDt
N
8
Transaction Request Date (YYYYMMDD)
20220519
reqTm
N
6
Transaction Request Time (HH24MISS)
144206
transDt
N
8
Transaction Date (YYYYMMDD)
null
transTm
N
6
Transaction Time (HH24MISS)
null
depositDt
N
8
Transaction Deposit Date (YYYYMMDD)
null
depositTm
N
6
Transaction Deposit Time (HH24MISS)
null
mitraCd
A
4
﻿Mitra Code﻿ 
null
instmntMon
N
2
Installment Month
null
instmntType
N
2
﻿Installment Type Code﻿ 
1
cardNo
N
20
﻿
﻿ Number 
null
preauthToken
AN
64
Pre-Auth Token
null
acquBankCd
A
4
﻿Acquiring Bank Code﻿ 
null
issuBankCd
A
4
﻿Issuing Bank Code﻿ 
null
vacctValidDt
N
8
VA Expiry Date (YYYYMMDD)	
null
vacctValidTm
N
6
VA Expiry Time (HH24MISS)
null
vacctNo
N
20
﻿
﻿ Number
null
bankCd
A
4
﻿Bank Code﻿ 
null
payNo
N
12
CVS Number (CVS)
null
receiptCode
ANS
20
Authorization Number
null
recurringToken
AN
64
Recurring 
﻿ Token	
null
ccTransType
N
2
﻿Credit Card Transaction Type﻿﻿
null
payValidDt
N
8
Expiry Date (YYYYMMDD)
null
payValidTm
N
6
Expiry Time (HH24MISS)
null
mRefNo
AN
18
﻿
﻿ Reference Number
null
acquStatus
N
2
Purchase Status
1: Normal
2: Recurring
3: Pre-Auth
4: Capture
null
cardExpYymm
N
4
Card Expiration (YYMM)

null
acquBankNm
A
255
Acquiring 
﻿ Name
null
issuBankNm
A
255
Issuing 
﻿ Name
null
depositDt
N
8
Deposit Date (YYYYMMDD)
null
depositTm
N
6
Deposit Time (HH24MISS)
null
paymentExpDt
N
6
QR 
﻿ Expiry Date (YYYYMMDD)
null
paymentExpTm
N
6
QR 
﻿ Expiry Time (HH24MISS)
null
paymentTrxSn
N
32
﻿
﻿ Transaction Number
null
cancelAmt
N
12
Cancel Amount
null
cancelTrxSn
AN
32
Cancel Transaction Number
null
currency
A
3
Currency
IDR
goodsNm 
AN
100
Goods Name
Test Transaction
billingNm
A
100
Buyer name
John Doe
status
N
1
﻿Payment Status Code﻿ 
9
userId
AN
128 
 
﻿ User ID Hash
null
shopId
AN
32
Shop ID
null
﻿
Sample JSON for Direct Debit Status Inquiry 
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "TNICECP04104202205191442060467",
    "iMid": "TNICECP041",
    "currency": "IDR",
    "amt": "2000",
    "instmntMon": null,
    "instmntType": "1",
    "referenceNo": "20220519144204",
    "goodsNm": "Test Transaction",
    "payMethod": "04",
    "billingNm": "John Doe",
    "reqDt": "20220519",
    "reqTm": "144206",
    "status": "9",
    "resultCd": "0000",
    "resultMsg": "init",
    "cardNo": null,
    "preauthToken": null,
    "acquBankCd": null,
    "issuBankCd": null,
    "vacctValidDt": null,
    "vacctValidTm": null,
    "vacctNo": null,
    "bankCd": null,
    "payNo": null,
    "mitraCd": null,
    "receiptCode": null,
    "cancelAmt": null,
    "transDt": null,
    "transTm": null,
    "recurringToken": null,
    "ccTransType": null,
    "payValidDt": null,
    "payValidTm": null,
    "mRefNo": null,
    "acquStatus": null,
    "cardExpYymm": null,
    "acquBankNm": null,
    "issuBankNm": null,
    "depositDt": null,
    "depositTm": null,
    "paymentExpDt": null,
    "paymentExpTm": null,
    "paymentTrxSn": null,
    "cancelTrxSn": null,
    "userId": null,
    "shopId": null
}
{
    "tXid": "TNICECP04104202205191442060467",
    "iMid": "TNICECP041",
    "currency": "IDR",
    "amt": "2000",
    "instmntMon": null,
    "instmntType": "1",
    "referenceNo": "20220519144204",
    "goodsNm": "Test Transaction",
    "payMethod": "04",
    "billingNm": "John Doe",
    "reqDt": "20220519",
    "reqTm": "144206",
    "status": "9",
    "resultCd": "0000",
    "resultMsg": "init",
    "cardNo": null,
    "preauthToken": null,
    "acquBankCd": null,
    "issuBankCd": null,
    "vacctValidDt": null,
    "vacctValidTm": null,
    "vacctNo": null,
    "bankCd": null,
    "payNo": null,
    "mitraCd": null,
    "receiptCode": null,
    "cancelAmt": null,
    "transDt": null,
    "transTm": null,
    "recurringToken": null,
    "ccTransType": null,
    "payValidDt": null,
    "payValidTm": null,
    "mRefNo": null,
    "acquStatus": null,
    "cardExpYymm": null,
    "acquBankNm": null,
    "issuBankNm": null,
    "depositDt": null,
    "depositTm": null,
    "paymentExpDt": null,
    "paymentExpTm": null,
    "paymentTrxSn": null,
    "cancelTrxSn": null,
    "userId": null,
    "shopId": null
}
﻿
﻿

API Endpoint	/nicepay/direct/v2/inquiry
Request Method	POST
Description	Performs Inquiry Request to for Status Checking
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format	application/json

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20220521144206
tXid Required	AN	30	Transaction ID	TNICECP04104202205191442060467
iMid Required	AN	10	ID	TNICECP041
referenceNo Required	ANS	40	Order Number	20220519144204
amt Required	N	12	Transaction Amount	2000
merchantToken Required	AN	255	Token	415c63ed51b7fd1f8fb39b48138cd15d8edf301309b2330f7548970196a0073c

Parameter	Type	Size	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	unpaid
tXid	AN	30	Transaction ID	TNICECP04104202205191442060467
iMid	AN	10	ID	TNICECP041
referenceNo	ANS	40	Reference Number	20220519144204
payMethod	N	2	Payment Method Code	04
amt	N	12	Amount	2000
CancelAmt	N	12	Cancel amount	null
reqDt	N	8	Transaction Request Date (YYYYMMDD)	20220519
reqTm	N	6	Transaction Request Time (HH24MISS)	144206
transDt	N	8	Transaction Date (YYYYMMDD)	null
transTm	N	6	Transaction Time (HH24MISS)	null
depositDt	N	8	Transaction Deposit Date (YYYYMMDD)	null
depositTm	N	6	Transaction Deposit Time (HH24MISS)	null
mitraCd	A	4	Mitra Code	null
instmntMon	N	2	Installment Month	null
instmntType	N	2	Installment Type Code	1
cardNo	N	20	Number	null
preauthToken	AN	64	Pre-Auth Token	null
acquBankCd	A	4	Acquiring Bank Code	null
issuBankCd	A	4	Issuing Bank Code	null
vacctValidDt	N	8	VA Expiry Date (YYYYMMDD)	null
vacctValidTm	N	6	VA Expiry Time (HH24MISS)	null
vacctNo	N	20	Number	null
bankCd	A	4	Bank Code	null
payNo	N	12	CVS Number (CVS)	null
receiptCode	ANS	20	Authorization Number	null
recurringToken	AN	64	Recurring Token	null
ccTransType	N	2	Credit Card Transaction Type	null
payValidDt	N	8	Expiry Date (YYYYMMDD)	null
payValidTm	N	6	Expiry Time (HH24MISS)	null
mRefNo	AN	18	Reference Number	null
acquStatus	N	2	Purchase Status 1: Normal 2: Recurring 3: Pre-Auth 4: Capture	null
cardExpYymm	N	4	Card Expiration (YYMM)	null
acquBankNm	A	255	Acquiring Name	null
issuBankNm	A	255	Issuing Name	null
depositDt	N	8	Deposit Date (YYYYMMDD)	null
depositTm	N	6	Deposit Time (HH24MISS)	null
paymentExpDt	N	6	QR Expiry Date (YYYYMMDD)	null
paymentExpTm	N	6	QR Expiry Time (HH24MISS)	null
paymentTrxSn	N	32	Transaction Number	null
cancelAmt	N	12	Cancel Amount	null
cancelTrxSn	AN	32	Cancel Transaction Number	null
currency	A	3	Currency	IDR
goodsNm	AN	100	Goods Name	Test Transaction
billingNm	A	100	Buyer name	John Doe
status	N	1	Payment Status Code	9
userId	AN	128	User ID Hash	null
shopId	AN	32	Shop ID	null

Updated 05 Sep 2024

Did this page help you?

Registration - API Direct Debit

Notification - API Direct Debit

Status Inquiry - API Direct Debit

About API Direct Debit Status Inquiry

API Direct Debit Status Inquiry

Request Parameter for Direct Debit Status Inquiry

Response Parameter for Direct Debit Status Inquiry

Sample JSON for Direct Debit Status Inquiry

Welcome to NICEPAY DOCS