Status Inquiry - API E-Wallet

11min

About API E-Wallet Status Inquiry
﻿
Integration of  Status Inquiry  in  is required so that s can check  ongoing  of    carried out by   whether   is success, fail, and others. So that   can have a report on that .
﻿
API E-Wallet Status Inquiry
﻿
Integration of Inquiry  on s aims to enable s to connect with    to check   of  s 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 encourage s to verify   using  Status Inquiry - API E-Wallet﻿.
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 E-Wallet﻿ 
﻿
Request Parameter for E-Wallet Status Inquiry
﻿
The following is a list of s for request a  inquiries on   .
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20221208065959
tXid
Required
﻿
AN
30
Transaction Id
IONPAYTEST05202212081111197444
iMid
﻿Required
﻿
AN
10
﻿ ID
IONPAYTEST
referenceNo
Required
﻿
ANS
40
﻿ Order Number
ORD20221208
amt
Required
﻿
N
12
Transaction Amount	
2000
merchantToken
Required
﻿
AN
255
﻿ token
324a7d07d9f3fe30a3960b28af29a91fc30a33fb3332cf33d40394f30d1f399f
﻿
Response Parameter for E-Wallet Status Inquiry  
﻿
The following is a list of responses to request  inquiries on   es.
Parameter
Type
Size
Description
Example / Notes
resultCd
N
4
﻿Result Code﻿ 
0000
resultMsg
AN
255
Result Message: Error Code﻿ 
paid
tXid
AN
30
Transaction ID
IONPAYTEST05202212081111197444
iMid
AN
10
﻿ ID
IONPAYTEST
currency
A
3
Currency
IDR
referenceNo 
ANS
40
﻿ Reference Number
ORD20221208
payMethod
N
2
﻿Payment Method Code﻿ 
05
amt 
N
12
﻿ Amount
2000
CancelAmt
N
12
Cancel Amount
﻿
reqDt
N
8
Transaction Request Date (YYYYMMDD)
20221208
reqTm
N
6
Transaction Request Time (HH24MISS)
111119
transDt
N
8
Transaction Date (YYYYMMDD)
20221208
transTm
N
6
Transaction Time (HH24MISS)
111234
instmntMon
N
2
Installment Month
null
instmntType
N
2
﻿Installment Type Code﻿ 
1
cardNo
ANS
20
Masker Card 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
16
﻿  Number
null
bankCd
A
4
﻿Bank Code﻿ 
null
payNo
N
12
﻿ Number
null
mitraCd
A
4
﻿Mitra Code﻿ 
DANA
receiptCode
ANS
20
Authorization Number
null
recurringToken
AN
64
Recurring Token
null
 ccTransType
N
2
﻿Credit Card Transaction Type﻿﻿
null
payValidDt
N
8
CVS Expiry Date (YYYYMMDD) (CVS)
null
payValidTm
N
6
CVS Expiry Time (HH24MISS) (CVS)
null
mRefNo
AN
20
﻿ Reference Number ()
null
acquStatus
N
2
Purchase Status
1 : Normal
2 : Recurring
3 : Pre-Auth
4 : Capture
null
cardExpYymm
N
4
Card Expiry (YYMM)
null
acquBankNm
A
255
Acquiring  Name
null
issuBankNm
A
255
Issuing  Name
null
depositDt
N
8
Transaction deposit date (YYYYMMDD)
null
depositTm
N
6
Transaction Deposit Time (HH24MISS)
null
userId
AN
128
﻿ User ID Hash
null
shopId
AN
32
Shop ID
null
currency 
A
3
Currency
null
goodsNm 
AN
100
Goods Name
Test Transaction  - Riko Adi Setiawan
billingNm 
A
100
Buyer name
Riko Adi Setiawan
status
N
1
﻿Payment Status Code﻿ 
0
﻿
Additional Response Parameter for Others Status Inquiry
﻿
The following is additional response list  from request  inquiry in other  es.
Parameter
Type
Size
Description
mitraCd
A
4
﻿Mitra Code﻿  (CVS, , , )
payNo
N
12
CVS Number (CVS)

payValidDt
N
8
CVS Expiry Date (YYYYMMDD) (CVS)
payValidTm
N
6
CVS Expiry Time (HH24MISS) (CVS)
receiptCode
ANS
20
Authorization Code (CVS)
mRefNo
AN
20
﻿ Reference Number ()



Sample JSON for E-Wallet Status Inquiry 
﻿
JSON Request
JSON Response
Java Request
{
	"tXid": "IONPAYTEST05202212081111197444",
	"iMid": "IONPAYTEST",
	"currency": "IDR",
	"amt": "2000",
	"instmntMon": null,
	"instmntType": "1",
	"referenceNo": "ORD20221208",
	"goodsNm": "Test Transaction Nicepay - Riko Adi Setiawan",
	"payMethod": "05",
	"billingNm": "Riko Adi Setiawan",
	"reqDt": "20221208",
	"reqTm": "111119",
	"status": "0",
	"resultCd": "0000",
	"resultMsg": "paid",
	"cardNo": null,
	"preauthToken": null,
	"acquBankCd": null,
	"issuBankCd": null,
	"vacctValidDt": null,
	"vacctValidTm": null,
	"vacctNo": null,
	"bankCd": null,
	"payNo": null,
	"mitraCd": "DANA",
	"receiptCode": null,
	"cancelAmt": null,
	"transDt": "20221208",
	"transTm": "111234",
	"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": "IONPAYTEST05202212081111197444",
	"iMid": "IONPAYTEST",
	"currency": "IDR",
	"amt": "2000",
	"instmntMon": null,
	"instmntType": "1",
	"referenceNo": "ORD20221208",
	"goodsNm": "Test Transaction Nicepay - Riko Adi Setiawan",
	"payMethod": "05",
	"billingNm": "Riko Adi Setiawan",
	"reqDt": "20221208",
	"reqTm": "111119",
	"status": "0",
	"resultCd": "0000",
	"resultMsg": "paid",
	"cardNo": null,
	"preauthToken": null,
	"acquBankCd": null,
	"issuBankCd": null,
	"vacctValidDt": null,
	"vacctValidTm": null,
	"vacctNo": null,
	"bankCd": null,
	"payNo": null,
	"mitraCd": "DANA",
	"receiptCode": null,
	"cancelAmt": null,
	"transDt": "20221208",
	"transTm": "111234",
	"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)	20221208065959
tXid Required	AN	30	Transaction Id	IONPAYTEST05202212081111197444
iMid Required	AN	10	ID	IONPAYTEST
referenceNo Required	ANS	40	Order Number	ORD20221208
amt Required	N	12	Transaction Amount	2000
merchantToken Required	AN	255	token	324a7d07d9f3fe30a3960b28af29a91fc30a33fb3332cf33d40394f30d1f399f

Parameter	Type	Size	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	paid
tXid	AN	30	Transaction ID	IONPAYTEST05202212081111197444
iMid	AN	10	ID	IONPAYTEST
currency	A	3	Currency	IDR
referenceNo	ANS	40	Reference Number	ORD20221208
payMethod	N	2	Payment Method Code	05
amt	N	12	Amount	2000
CancelAmt	N	12	Cancel Amount
reqDt	N	8	Transaction Request Date (YYYYMMDD)	20221208
reqTm	N	6	Transaction Request Time (HH24MISS)	111119
transDt	N	8	Transaction Date (YYYYMMDD)	20221208
transTm	N	6	Transaction Time (HH24MISS)	111234
instmntMon	N	2	Installment Month	null
instmntType	N	2	Installment Type Code	1
cardNo	ANS	20	Masker Card 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	16	Number	null
bankCd	A	4	Bank Code	null
payNo	N	12	Number	null
mitraCd	A	4	Mitra Code	DANA
receiptCode	ANS	20	Authorization Number	null
recurringToken	AN	64	Recurring Token	null
ccTransType	N	2	Credit Card Transaction Type	null
payValidDt	N	8	CVS Expiry Date (YYYYMMDD) (CVS)	null
payValidTm	N	6	CVS Expiry Time (HH24MISS) (CVS)	null
mRefNo	AN	20	Reference Number ()	null
acquStatus	N	2	Purchase Status 1 : Normal 2 : Recurring 3 : Pre-Auth 4 : Capture	null
cardExpYymm	N	4	Card Expiry (YYMM)	null
acquBankNm	A	255	Acquiring Name	null
issuBankNm	A	255	Issuing Name	null
depositDt	N	8	Transaction deposit date (YYYYMMDD)	null
depositTm	N	6	Transaction Deposit Time (HH24MISS)	null
userId	AN	128	User ID Hash	null
shopId	AN	32	Shop ID	null
currency	A	3	Currency	null
goodsNm	AN	100	Goods Name	Test Transaction - Riko Adi Setiawan
billingNm	A	100	Buyer name	Riko Adi Setiawan
status	N	1	Payment Status Code	0

Parameter	Type	Size	Description
mitraCd	A	4	Mitra Code (CVS, , , )
payNo	N	12	CVS Number (CVS)
payValidDt	N	8	CVS Expiry Date (YYYYMMDD) (CVS)
payValidTm	N	6	CVS Expiry Time (HH24MISS) (CVS)
receiptCode	ANS	20	Authorization Code (CVS)
mRefNo	AN	20	Reference Number ()

Updated 18 Sep 2024

Did this page help you?

Payment - API E-Wallet

Notification - API E-Wallet

Status Inquiry - API E-Wallet

About API E-Wallet Status Inquiry

API E-Wallet Status Inquiry

Request Parameter for E-Wallet Status Inquiry

Response Parameter for E-Wallet Status Inquiry

Additional Response Parameter for Others Status Inquiry

Sample JSON for E-Wallet Status Inquiry

Welcome to NICEPAY DOCS