Status Inquiry - API Virtual Account

10min

About API Virtual Account Status Inquiry
﻿
Integration of 
﻿ Status Inquiry 
﻿ on 
﻿s 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 Virtual Account Status Inquiry 
﻿
Integration Inquiry Status on 
﻿ 
﻿ aims so 
﻿ 
﻿ can connect to 
﻿ 
﻿ 
﻿ to perform 
﻿ checking on 
﻿ 
﻿ 
﻿ regularly.

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 Virtual Account﻿.
Notification Handling is very useful to minimize 
﻿ risk of Fraud. We strongly encourage 
﻿s to verify Notification Handling using Notification - API Virtual Account SNAP﻿.
﻿
Request Parameter for Virtual Account 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)
20221215091222
tXid
Required
﻿
AN
30
Transaction ID
NORMALTEST02202212150929011967
iMid
﻿Required
﻿
AN
10
﻿
﻿ ID
NORMALTEST
referenceNo
Required
﻿
ANS
40
﻿
﻿ Order Number
ordNo20221215091214
amt
Required
﻿
N
12
Transaction Amount	
1000
merchantToken
Required
﻿
AN
255
﻿
﻿ Token
ea6e691a895f1ccc0602f534205ee60bc552552dde7610062cd048ea6c87965e
﻿
Response Parameter for Virtual Account Status Inquiry
﻿
The following is a list of responses to requests for 
﻿ inquiry 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
NORMALTEST02202212150929011967
iMid 
AN
10
﻿
﻿ ID
NORMALTEST
referenceNo 
ANS
40
﻿
﻿ Reference Number
ordNo20221215091214
payMethod 
N
2
﻿Payment Method Code﻿ 
02
amt 
N
12
﻿
﻿ Amount
10000
CancelAmt
N
12
Cancel amount
null
reqDt 
N
8
Transaction Request Date (YYYYMMDD)
20221215
reqTm 
N
6
Transaction Request Time (HH24MISS)
092901
transDt
N
8
Transaction Date (YYYYMMDD)
20221215
transTm
N
6
Transction Time (HH24MISS)
092901
depositDt
N
8
Transaction Deposit Date (YYYYMMDD)
null
depositTm
N
6
Transaction Deposit Time (HH24MISS)
null
mitraCd
A
4
﻿Mitra Code﻿ 
ALMA
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)	
20221231
vacctValidTm 
N
6
VA Expiry Time (HH24MISS)
235959
vacctNo
N
20
﻿
﻿ Number
9912304000001487
bankCd 
A
4
﻿Bank Code﻿ 
CENA
payNo 
N
12
CVS number (CVS)
null
mitraCd
A
4
﻿Mitra Code﻿ 
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)
20221215
depositTm
N
6
Deposit Time (HH24MISS)
092936
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 Nicepay
billingNm 
A
100
Buyer name
John Doe
status
N
1
﻿Payment Status Code﻿﻿
0
userId
AN
128 
﻿
﻿ User ID Hash
null
shopId
AN
32
Shop ID
null
﻿
Additional Response Parameter for Virtual Account Status Inquiry
﻿
The following is a list of additional responses from 
﻿ inquiry 
﻿ request in 
﻿ 
﻿ 
﻿ 
﻿ .
Parameter
Type
Size
Descriprion
bankCd
A
4
﻿Bank Code﻿ 
vacctNo
N
16
﻿
﻿ 
﻿ Number
vacctValidDt
N
8
VA Expiry Date (YYYYMMDD)
vacctValidTm
N
9
VA Expiry Time (HH24MISS)
﻿
Sample JSON for Virtual Account Status Inquiry 
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "NORMALTEST02202212150929011967",
    "iMid": "NORMALTEST",
    "currency": "IDR",
    "amt": "10000",
    "instmntMon": null,
    "instmntType": "1",
    "referenceNo": "ordNo20221215091214",
    "goodsNm": "Goods",
    "payMethod": "02",
    "billingNm": "John Doe",
    "reqDt": "20221215",
    "reqTm": "092901",
    "status": "0",
    "resultCd": "0000",
    "resultMsg": "paid",
    "cardNo": null,
    "preauthToken": null,
    "acquBankCd": null,
    "issuBankCd": null,
    "vacctValidDt": "20221231",
    "vacctValidTm": "235959",
    "vacctNo": "9912304000001487",
    "bankCd": "CENA",
    "payNo": null,
    "mitraCd": null,
    "receiptCode": null,
    "cancelAmt": null,
    "transDt": "20221215",
    "transTm": "092901",
    "recurringToken": null,
    "ccTransType": null,
    "payValidDt": null,
    "payValidTm": null,
    "mRefNo": null,
    "acquStatus": null,
    "cardExpYymm": null,
    "acquBankNm": null,
    "issuBankNm": null,
    "depositDt": "20221215",
    "depositTm": "092936",
    "paymentExpDt": null,
    "paymentExpTm": null,
    "paymentTrxSn": null,
    "cancelTrxSn": null,
    "userId": null,
    "shopId": null
}
{
    "tXid": "NORMALTEST02202212150929011967",
    "iMid": "NORMALTEST",
    "currency": "IDR",
    "amt": "10000",
    "instmntMon": null,
    "instmntType": "1",
    "referenceNo": "ordNo20221215091214",
    "goodsNm": "Goods",
    "payMethod": "02",
    "billingNm": "John Doe",
    "reqDt": "20221215",
    "reqTm": "092901",
    "status": "0",
    "resultCd": "0000",
    "resultMsg": "paid",
    "cardNo": null,
    "preauthToken": null,
    "acquBankCd": null,
    "issuBankCd": null,
    "vacctValidDt": "20221231",
    "vacctValidTm": "235959",
    "vacctNo": "9912304000001487",
    "bankCd": "CENA",
    "payNo": null,
    "mitraCd": null,
    "receiptCode": null,
    "cancelAmt": null,
    "transDt": "20221215",
    "transTm": "092901",
    "recurringToken": null,
    "ccTransType": null,
    "payValidDt": null,
    "payValidTm": null,
    "mRefNo": null,
    "acquStatus": null,
    "cardExpYymm": null,
    "acquBankNm": null,
    "issuBankNm": null,
    "depositDt": "20221215",
    "depositTm": "092936",
    "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)	20221215091222
tXid Required	AN	30	Transaction ID	NORMALTEST02202212150929011967
iMid Required	AN	10	ID	NORMALTEST
referenceNo Required	ANS	40	Order Number	ordNo20221215091214
amt Required	N	12	Transaction Amount	1000
merchantToken Required	AN	255	Token	ea6e691a895f1ccc0602f534205ee60bc552552dde7610062cd048ea6c87965e

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	NORMALTEST02202212150929011967
iMid	AN	10	ID	NORMALTEST
referenceNo	ANS	40	Reference Number	ordNo20221215091214
payMethod	N	2	Payment Method Code	02
amt	N	12	Amount	10000
CancelAmt	N	12	Cancel amount	null
reqDt	N	8	Transaction Request Date (YYYYMMDD)	20221215
reqTm	N	6	Transaction Request Time (HH24MISS)	092901
transDt	N	8	Transaction Date (YYYYMMDD)	20221215
transTm	N	6	Transction Time (HH24MISS)	092901
depositDt	N	8	Transaction Deposit Date (YYYYMMDD)	null
depositTm	N	6	Transaction Deposit Time (HH24MISS)	null
mitraCd	A	4	Mitra Code	ALMA
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)	20221231
vacctValidTm	N	6	VA Expiry Time (HH24MISS)	235959
vacctNo	N	20	Number	9912304000001487
bankCd	A	4	Bank Code	CENA
payNo	N	12	CVS number (CVS)	null
mitraCd	A	4	Mitra Code	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)	20221215
depositTm	N	6	Deposit Time (HH24MISS)	092936
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 Nicepay
billingNm	A	100	Buyer name	John Doe
status	N	1	Payment Status Code	0
userId	AN	128	User ID Hash	null
shopId	AN	32	Shop ID	null

Parameter	Type	Size	Descriprion
bankCd	A	4	Bank Code
vacctNo	N	16	Number
vacctValidDt	N	8	VA Expiry Date (YYYYMMDD)
vacctValidTm	N	9	VA Expiry Time (HH24MISS)

Updated 04 Sep 2024

Did this page help you?

Cancel - API Virtual Account

Notification - API Virtual Account

Status Inquiry - API Virtual Account

About API Virtual Account Status Inquiry

API Virtual Account Status Inquiry

Request Parameter for Virtual Account Status Inquiry

Response Parameter for Virtual Account Status Inquiry

Additional Response Parameter for Virtual Account Status Inquiry

Sample JSON for Virtual Account Status Inquiry

Welcome to NICEPAY DOCS