NICEPAY API V2 Status Inquiry - API Checkout

Status Inquiry - API Checkout

11min

About Status Inquiry - API Checkout
﻿
After you integrate successfully with 
﻿ Registration - API Checkout﻿, your 
﻿ is ready to do 
﻿s in real with your 
﻿. However, 
﻿ recommend you to performs other Checkout API﻿ 
﻿ like this Inquiry 
﻿.
This 
﻿ uses to check on 
﻿ 
﻿ you are requested on 
﻿ previous Registration - API Checkout﻿ such as successful or failed 
﻿ 
﻿.
When 
﻿ 
﻿ is completed, you will automatically get 
﻿ from us. 
﻿ strongly recommend you to re-check 
﻿ 
﻿ 
﻿ using Status Inquiry - API Checkout﻿.
﻿
Status Inquiry - API Checkout
﻿
API URL
/nicepay/direct/v2/inquiry
Request Method 
POST
Header
﻿Content-Type: application/json﻿
Merchant Token
SHA256 (timestamp+ iMid+ referenceNo+ amt+ merchantKey)
When 
﻿ received to your dbProcessUrl, we strongly recommend 
﻿ to verify 
﻿ Notification using Status Inquiry - API Checkout﻿.
﻿
Notification Handling
Notification Handling is useful to minimalize Fraud actions, we strongly recommend 
﻿s to verify 
﻿ Notification Handling.
Status Inquiry - Notification Handling
﻿
﻿
Request Parameters
Parameter
Type
Size
Description
Remark
timeStamp
﻿Required﻿
N
14
﻿
﻿ Request Date (YYYYMMDDHH24MISS)
20221012080918
tXid
﻿Required﻿
AN
30
Transaction ID
﻿
IONPAYTEST00202212191025073439
iMid
﻿Required﻿
AN
10
﻿
﻿ ID
﻿
IONPAYTEST
referenceNo
﻿Required﻿
ANS
40
﻿
﻿ Order Number
﻿
ORDER20221012080918
amt
﻿Required﻿
N
12
Transaction Amount
﻿
10000
merchantToken
﻿Required﻿
AN
255
﻿
﻿ Token
﻿
d8d0968892c568bc6ff5adc17cd755f85334a0b58fce85392682993a9ba653ed
﻿
Response Parameters
Parameter
Type
Size
Description
Remark
resultCd
N
4
﻿Result Code﻿ 
0000
resultMsg
AN
255
Result Message: Error Code﻿ 
(empty)
tXid
AN
30
Transaction ID
IONPAYTEST00202212191025073439
iMid
AN
10
﻿
﻿ ID
IONPAYTEST
referenceNo
ANS
40
﻿
﻿ Order Number
ORDER20221012080918
payMethod
N
2
﻿Payment Method Code﻿ 
00
amt
N
12
﻿
﻿ Amount
10000
cancelAmt
N
12
Cancel Amount
null
reqDt
N
8
Transaction Request Date (YYYYMMDD)
20221219
reqTm
N
6
Transaction Request Time (HH24MISS)
102507
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
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﻿﻿
null
Additional - Credit Card
Parameter
Type
Size
Description
Remark
authNo
N
10
Approval Number
﻿
issuBankCd
A
4
﻿Issuing Bank Code﻿ 
﻿
acquBankCd
A
4
﻿Acquiring Bank Code﻿ 
﻿
acquBankNm
A
255
Acquiring 
﻿ Name
﻿
issuBankNm
A
255
Issuing 
﻿ Name
﻿
cardNo
ANS
20
Card Number ith Masking
﻿
cardExpYymm
N
4
Card Expiration (YYMM)
﻿
instmntMon
N
2
Installment Month 
1: 1 Month/Full 
﻿, if instmntType: null/1
3: 3 Months
6: 6 Months
12: 12 Months
﻿
instmntType
N
2
﻿Installment Type Code﻿﻿
﻿
preauthToken
AN
255
Pre-Auth Token (Needed for Capture 
﻿)
﻿
recurringToken
AN
255
Recurring Token (Needed for Recurring 
﻿ )
﻿
ccTransType
N
2
﻿Credit Card Transaction Type﻿﻿
﻿
acquStatus
N
2
Purchase Status
1: Normal
2: Recurring
3: Pre-auth
4: Capture
﻿
vat
N
12
﻿
﻿﻿
﻿
fee
N
12
Service Fee
﻿
notaxAmt
N
12
Tax-Fee Amount
﻿
Additional - Virtual Account
Parameter
Type
Size
Description
Remark
bankCd
A
4
﻿Bank Code﻿ 
﻿
vacctNo
N
16
﻿
﻿ 
﻿ Number
﻿
vacctValidDt
N
8
VA Expiry date (YYYYMMDD)
﻿
vacctValidTm
N
6
VA Expiry time (HH24MISS)
﻿
Additional - Others
Parameter
Type
Size
Description
Remark
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 API Checkout Status Inquiry
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "IONPAYTEST00202212191025073439",
    "iMid": "IONPAYTEST",
    "currency": "IDR",
    "amt": "10000",
    "instmntMon": "1",
    "instmntType": "2",
    "referenceNo": "ORDER20221012080918",
    "goodsNm": "Test Transaction Nicepay",
    "payMethod": "00",
    "billingNm": "John Doe",
    "reqDt": "20221219",
    "reqTm": "102507",
    "status": null,
    "resultCd": "0000",
    "resultMsg": "",
    "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": "IONPAYTEST00202212191025073439",
    "iMid": "IONPAYTEST",
    "currency": "IDR",
    "amt": "10000",
    "instmntMon": "1",
    "instmntType": "2",
    "referenceNo": "ORDER20221012080918",
    "goodsNm": "Test Transaction Nicepay",
    "payMethod": "00",
    "billingNm": "John Doe",
    "reqDt": "20221219",
    "reqTm": "102507",
    "status": null,
    "resultCd": "0000",
    "resultMsg": "",
    "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
}
﻿
﻿

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 URL	/nicepay/direct/v2/inquiry
Request Method	POST
Header	Content-Type: application/json
Merchant Token	SHA256 (timestamp+ iMid+ referenceNo+ amt+ merchantKey)

Parameter	Type	Size	Description	Remark
timeStamp Required	N	14	Request Date (YYYYMMDDHH24MISS)	20221012080918
tXid Required	AN	30	Transaction ID	IONPAYTEST00202212191025073439
iMid Required	AN	10	ID	IONPAYTEST
referenceNo Required	ANS	40	Order Number	ORDER20221012080918
amt Required	N	12	Transaction Amount	10000
merchantToken Required	AN	255	Token	d8d0968892c568bc6ff5adc17cd755f85334a0b58fce85392682993a9ba653ed

Status Inquiry - API Checkout

About Status Inquiry - API Checkout

Status Inquiry - API Checkout

Notification Handling

Request Parameters

Response Parameters

Additional - Credit Card

Additional - Virtual Account

Additional - Others

Sample JSON for API Checkout Status Inquiry

Welcome to NICEPAY DOCS