Status Inquiry - API Credit Card

10min

About API Credit Card Status Inquiry
﻿
Integration with  Status Inquiry  on s is required so that s can check   of ongoing  es, whether they are successful, failed, and other .
﻿
API Credit Card Status Inquiry
﻿
The  of  inquiries on s aims to enable s to connect with    which has function to checking   of  s.

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 Credit Card﻿.
Notification Handling is very useful to minimize the risk of Fraud. We strongly encourage s to verify Notification Handling. You can read more detailed  about Notification Handling on Notification - API Credit Card﻿ . 
﻿
Request Parameter for Credit Card Status Inquiry
﻿
The following is a list of request s to    Inquiry request on   :
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20221214091282
tXid
Required
﻿
AN
30
Transaction ID
IONPAYTEST01202212140949101366
iMid
﻿Required
﻿
AN
10
﻿ ID
IONPAYTEST
referenceNo
Required
﻿
ANS
40
﻿ Order Number
ordNo20221214091293

amt
Required
﻿
N
12
Transaction Amount	
5000
merchantToken
Required
﻿
AN
255
﻿ Token
7eceb5801db4e039223698c4eb9...
﻿
Response Parameter for Credit Card Status Inquiry
﻿
The following is a list of Response Parameter or  result from  Request Parameter for Status Inquiry .
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
IONPAYTEST01202212140949101366
iMid 
AN
10
﻿ ID

IONPAYTEST
currency
A
3
Currency
IDR
instmntMon
N
2
Installment Month
1
instmntType
N
2
﻿Installment Type Code﻿ 
1
referenceNo 
ANS
40
﻿ Reference Number
ordNo20221214091293
payMethod
N
2
﻿Payment Method Code﻿ 
01
amt
N
12
﻿ Amount
5000
CancelAmt
N
12
Cancel amount
null
reqDt 
N
8
Transaction Request Date (YYYYMMDD)
20221214
reqTm 
N
6
Transaction Request Time (HH24MISS)
094910
status
N
1
Transaction Status
0
transDt
N
8
Transaction Date (YYYYMMDD)
20221214
transTm
N
6
Transaction Time (HH24MISS)
094910
depositDt
N
8
Transaction Deposit Date (YYYYMMDD)
null
depositTm
N
6
Transaction Deposit Time (HH24MISS)
null
currency
A
3
Currency
IDR
goodsNm 
AN
100
Goods Name
Goods
billingNm 
A
100
Buyer Name
John Doe
status
N
1
﻿Payment Status Code﻿﻿
0
﻿
Additional Response Parameter for Credit Card Status Inquiry
﻿
Here is a list of additional response  for  result from  request  inquiry for  .
Parameter
Type
Size
Description
Example / Notes
authNo
N
10
Auth Number
101366
issuBankCd
A
4
﻿Issuing Bank Code﻿ 
OTHR
acquBankCd
A
4
﻿Acquiring Bank Code﻿ 
BMRI
acquBankNm
A
255
Acquiring  Name
Mandiri
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
null
mitraCd
A
4
﻿Mitra Code﻿ 
null
receiptCode
ANS
20
Authorization Number
null
cancelAmt
N
12
Cancel Amount
null
payValidDt
N
8
CVS Expiry Date (YYYYMMDD) 
null
payValidTm
N
6
CVS Expiry Time (HH24MISS) 
null
mRefNo
AN
20
﻿ Reference Number
null
issuBankNm
A
255
Issuing  Name
OTHER
paymentExpDt
N
6
﻿ Expiry Date (YYYYMMDD)
null
paymentExpTm
N
6
﻿ Expiry Time (HH24MISS)
null
paymentTrxSn
AN
32
﻿ Transaction Number
null
userId
AN
128
﻿ User ID Hash
null
shopId
AN
32
Shop ID
null
cardNo
ANS
20
Masked Card Number
453211*1111
cardExpYymm
N
4
Card Expiration (YYMM)
2712
instmntMon
N
2
Installment Month
1
instmntType
N
2
﻿Installment Type Code﻿ 
1
preauthToken
AN
255
Pre-Auth Token (Needed for Capture )
null
recurringToken
AN
255
Recurring Token (Needed for Recurring )
null
ccTransType
N
2
﻿Credit Card Transaction Type﻿﻿
1
acquStatus
N
2
Purchase Status
1: Normal
2: Recurring
3: Pre-Auth
4: Capture
10
acquirerData
Array
20
A dynamic array consisting of a unique reference number RRN that is provided by    when a refund is ed. This reference number can be used by   to track   of  refund with  .
"acquirerData": {
    "rrn": "332608321717"
  }

﻿
Sample JSON for Credit Card Status Inquiry
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "IONPAYTEST01202212140949101366",
    "iMid": "IONPAYTEST",
    "currency": "IDR",
    "amt": "5000",
    "instmntMon": "1",
    "instmntType": "1",
    "referenceNo": "ordNo20221214091293",
    "goodsNm": "Goods",
    "payMethod": "01",
    "billingNm": "John Doe",
    "reqDt": "20221214",
    "reqTm": "094910",
    "status": "0",
    "resultCd": "0000",
    "resultMsg": "paid",
    "cardNo": "453211*****1111",
    "preauthToken": null,
    "acquBankCd": "BMRI",
    "issuBankCd": "OTHR",
    "vacctValidDt": null,
    "vacctValidTm": null,
    "vacctNo": null,
    "bankCd": null,
    "payNo": null,
    "mitraCd": null,
    "receiptCode": null,
    "cancelAmt": null,
    "transDt": "20221214",
    "transTm": "094910",
    "recurringToken": null,
    "ccTransType": "1",
    "payValidDt": null,
    "payValidTm": null,
    "mRefNo": null,
    "acquStatus": "10",
    "cardExpYymm": "2712",
    "acquBankNm": "Mandiri",
    "issuBankNm": "OTHER",
    "depositDt": null,
    "depositTm": null,
    "paymentExpDt": null,
    "paymentExpTm": null,
    "paymentTrxSn": null,
    "cancelTrxSn": null,
    "userId": null,
    "shopId": null,
    "authNo": "101366",
    "acquirerData": {
      "rrn": "332608321717"
    }
}
{
    "tXid": "IONPAYTEST01202212140949101366",
    "iMid": "IONPAYTEST",
    "currency": "IDR",
    "amt": "5000",
    "instmntMon": "1",
    "instmntType": "1",
    "referenceNo": "ordNo20221214091293",
    "goodsNm": "Goods",
    "payMethod": "01",
    "billingNm": "John Doe",
    "reqDt": "20221214",
    "reqTm": "094910",
    "status": "0",
    "resultCd": "0000",
    "resultMsg": "paid",
    "cardNo": "453211*****1111",
    "preauthToken": null,
    "acquBankCd": "BMRI",
    "issuBankCd": "OTHR",
    "vacctValidDt": null,
    "vacctValidTm": null,
    "vacctNo": null,
    "bankCd": null,
    "payNo": null,
    "mitraCd": null,
    "receiptCode": null,
    "cancelAmt": null,
    "transDt": "20221214",
    "transTm": "094910",
    "recurringToken": null,
    "ccTransType": "1",
    "payValidDt": null,
    "payValidTm": null,
    "mRefNo": null,
    "acquStatus": "10",
    "cardExpYymm": "2712",
    "acquBankNm": "Mandiri",
    "issuBankNm": "OTHER",
    "depositDt": null,
    "depositTm": null,
    "paymentExpDt": null,
    "paymentExpTm": null,
    "paymentTrxSn": null,
    "cancelTrxSn": null,
    "userId": null,
    "shopId": null,
    "authNo": "101366",
    "acquirerData": {
      "rrn": "332608321717"
    }
}
﻿
﻿

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)	20221214091282
tXid Required	AN	30	Transaction ID	IONPAYTEST01202212140949101366
iMid Required	AN	10	ID	IONPAYTEST
referenceNo Required	ANS	40	Order Number	ordNo20221214091293
amt Required	N	12	Transaction Amount	5000
merchantToken Required	AN	255	Token	7eceb5801db4e039223698c4eb9...

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	IONPAYTEST01202212140949101366
iMid	AN	10	ID	IONPAYTEST
currency	A	3	Currency	IDR
instmntMon	N	2	Installment Month	1
instmntType	N	2	Installment Type Code	1
referenceNo	ANS	40	Reference Number	ordNo20221214091293
payMethod	N	2	Payment Method Code	01
amt	N	12	Amount	5000
CancelAmt	N	12	Cancel amount	null
reqDt	N	8	Transaction Request Date (YYYYMMDD)	20221214
reqTm	N	6	Transaction Request Time (HH24MISS)	094910
status	N	1	Transaction Status	0
transDt	N	8	Transaction Date (YYYYMMDD)	20221214
transTm	N	6	Transaction Time (HH24MISS)	094910
depositDt	N	8	Transaction Deposit Date (YYYYMMDD)	null
depositTm	N	6	Transaction Deposit Time (HH24MISS)	null
currency	A	3	Currency	IDR
goodsNm	AN	100	Goods Name	Goods
billingNm	A	100	Buyer Name	John Doe
status	N	1	Payment Status Code	0

Parameter	Type	Size	Description	Example / Notes
authNo	N	10	Auth Number	101366
issuBankCd	A	4	Issuing Bank Code	OTHR
acquBankCd	A	4	Acquiring Bank Code	BMRI
acquBankNm	A	255	Acquiring Name	Mandiri
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	null
mitraCd	A	4	Mitra Code	null
receiptCode	ANS	20	Authorization Number	null
cancelAmt	N	12	Cancel Amount	null
payValidDt	N	8	CVS Expiry Date (YYYYMMDD)	null
payValidTm	N	6	CVS Expiry Time (HH24MISS)	null
mRefNo	AN	20	Reference Number	null
issuBankNm	A	255	Issuing Name	OTHER
paymentExpDt	N	6	Expiry Date (YYYYMMDD)	null
paymentExpTm	N	6	Expiry Time (HH24MISS)	null
paymentTrxSn	AN	32	Transaction Number	null
userId	AN	128	User ID Hash	null
shopId	AN	32	Shop ID	null
cardNo	ANS	20	Masked Card Number	453211*1111
cardExpYymm	N	4	Card Expiration (YYMM)	2712
instmntMon	N	2	Installment Month	1
instmntType	N	2	Installment Type Code	1
preauthToken	AN	255	Pre-Auth Token (Needed for Capture )	null
recurringToken	AN	255	Recurring Token (Needed for Recurring )	null
ccTransType	N	2	Credit Card Transaction Type	1
acquStatus	N	2	Purchase Status 1: Normal 2: Recurring 3: Pre-Auth 4: Capture	10
acquirerData	Array	20	A dynamic array consisting of a unique reference number RRN that is provided by when a refund is ed. This reference number can be used by to track of refund with .	"acquirerData": { "rrn": "332608321717" }

Updated 11 Oct 2024

Did this page help you?

Cancel - API Credit Card

Notification - API Credit Card

Status Inquiry - API Credit Card

About API Credit Card Status Inquiry

API Credit Card Status Inquiry

Request Parameter for Credit Card Status Inquiry

Response Parameter for Credit Card Status Inquiry

Additional Response Parameter for Credit Card Status Inquiry

Sample JSON for Credit Card Status Inquiry

Welcome to NICEPAY DOCS