NICEPAY API V2 Payment - Status Inquiry - API E-Wallet

Status Inquiry - API E-Wallet

11min

About API E-Wallet Status Inquiry
﻿
Integration of the Status Inquiry API in E-Wallet is required so that Merchants can check the ongoing status of the transaction process carried out by the Customer whether the status is success, fail, and others. So that the system can have a report on that information.
﻿
API E-Wallet Status Inquiry
﻿
Integration of Inquiry status on E-Wallets aims to enable Merchants to connect with the API system to check the status of E-Wallet payment methods on a regular basis.

API Endpoint
/nicepay/direct/v2/inquiry
Request Method
﻿POST﻿
Description
Performs Inquiry Request to NICEPAY for Status Checking
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format
application/json
When your dbProcessUrl received a notification, NICEPAY strongly encourage Merchants to verify the notification using the Status Inquiry - API E-Wallet﻿.
Notification Handling is very useful to minimize the risk of Fraud. We strongly encourage Merchants to verify Notification Handling . You can read more detailed information about Notification Handling on Notification - API E-Wallet﻿ 
﻿
Request Parameter for E-Wallet Status Inquiry
﻿
The following is a list of parameters for request a status inquiries on E-Wallet transaction process.
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
Merchant ID
IONPAYTEST
referenceNo
Required
﻿
ANS
40
Merchant Order No
ORD20221208
amt
Required
﻿
N
12
Transaction Amount	
2000
merchantToken
Required
﻿
AN
255
Merchant token
324a7d07d9f3fe30a3960b28af29a91fc30a33fb3332cf33d40394f30d1f399f
﻿
Response Parameter for E-Wallet Status Inquiry  
﻿
The following is a list of responses to request status inquiries on E-Wallet transaction processes.
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
Merchant Id
IONPAYTEST
currency
A
3
Currency
IDR
referenceNo 
ANS
40
Merchant Ref. No
ORD20221208
payMethod
N
2
﻿Payment Method Code﻿ 
05
amt 
N
12
Payment 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
Transction Time (HH24MISS)
111234
instmntMon
N
2
Installment Month
null
instmntType
N
2
﻿Installment Type Code﻿ 
1
cardNo
ANS
20
Masker Card No
null
preauthToken
AN
64
Pre-Auth Payment 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
Bank Virtual Account Number
null
bankCd
A
4
﻿Bank Code﻿ 
null
payNo
N
12
Payment Number
null
mitraCd
A
4
﻿Mitra Code﻿ 
DANA
receiptCode
ANS
20
Authorization number
null
recurringToken
AN
64
Reccurring 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
Bank reference No (Direct Debit)
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 bank name
null
issuBankNm
A
255
Issuing Bank Name
null
depositDt
N
8
Transaction deposit date (YYYYMMDD)
null
depositTm
N
6
Transaction deposit time (HH24MISS)
null
userId
AN
128
QRIS User ID Hash
null
shopId
AN
32
Shop Id
null
currency 
A
3
Currency
null
goodsNm 
AN
100
Goods Name
Test Transaction Nicepay - 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 information from request status inquiry in other transaction processes.
Parameter
Type
Size
Description
mitraCd
A
4
﻿Mitra Code﻿  (CVS, Direct Debit, E-Wallet, Payloan)
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
Bank reference No (Direct Debit)



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
}
﻿
﻿

Bank Indonesia already release API Standard relate to the Payment listed on Peraturan Anggota Dewan Gubernur No 23/15/PADG/2021 about Standar Nasional Open Application Interface Pembayaran (SNAP) Implementation.

As the form of suppport and compliance to Bank Indonesia Rules, NICEPAY drives all Merchant to conduct the migration to API SNAP BI.

All Merchants aim to complete the API SNAP BI migration on June 2024.

API Endpoint	/nicepay/direct/v2/inquiry
Request Method	POST
Description	Performs Inquiry Request to NICEPAY 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	Merchant ID	IONPAYTEST
referenceNo Required	ANS	40	Merchant Order No	ORD20221208
amt Required	N	12	Transaction Amount	2000
merchantToken Required	AN	255	Merchant token	324a7d07d9f3fe30a3960b28af29a91fc30a33fb3332cf33d40394f30d1f399f

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