Status Inquiry - API Payloan

10 min

About API Payloan 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, ﻿ ﻿ can have a report on that ﻿.
﻿
API Payloan Status Inquiry
﻿
Integration of Inquiry Status on ﻿ ﻿ aims to enable ﻿s to connect with ﻿ ﻿ ﻿ to check ﻿ ﻿ of ﻿ ﻿s regularly.

API End Point
/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 Payloan﻿﻿
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 Payloan﻿ ﻿.
﻿
Request Parameter for Payloan Status Inquiry 
﻿
The following is a list of responses to request ﻿ inquiries on ﻿ ﻿ ﻿es.
Parameter
Type
Size
Description
Example / Notes
timeStamp
﻿Required
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20221114114338
tXid
Required
﻿
AN
30
Transaction ID
PAYLOANTES06202212051018325178
iMid
﻿Required
﻿
AN
10
﻿﻿ ID
PAYLOANTES
referenceNo
Required﻿
ANS
40
﻿﻿ Order Number
ORD12345
amt
Required
﻿
N
12
Transaction Amount	
10000
merchantToken
Required
﻿
AN
255
﻿﻿ token
3a04d0c8581ae37727f87130a0b32f2fe9fe39c66b88347352e7b90aeb5cb6e6
﻿
Response Parameter for Payloan 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﻿ 
init
tXid
AN
30
Transaction ID
PAYLOANTES06202212051018325178
iMid 
AN
10
﻿﻿ ID

PAYLOANTES
referenceNo
ANS
40
﻿﻿ Reference Number
ORD12345
payMethod 
N
2
﻿Payment Method Code﻿ 
06
amt 
N
12
﻿﻿ Amount
10000
CancelAmt
N
12
Cancel Amount
Null
reqDt
N
8
Transaction Request Date (YYYYMMDD)
20221205
reqTm
N
6
Transaction Request Time (HH24MISS)
101832
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﻿﻿
9
instmntMon
N
2
Installment Month
1
instmntType
N
2
﻿Installment Type Code﻿ 
2
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)
Null
vacctValidTm
N
6
VA Expiry Time (HH24MISS)
Null
vacctNo
N
20
VA Number
Null
bankCd
A
4
﻿Bank Code﻿ 
Null
payNo
N
12
﻿﻿ Number
Null
mitraCd
A
4
﻿Mitra Code﻿ 
KDVI
receiptCode
ANS
20
Authorization Number
Null
cancelAmt
N
12
Cancel Amount
Null
recurringToken
AN
255
Recurring Token (Needed for Recurring ﻿)
﻿
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
Expiry (YYMM)
Null
acquBankNm
A
255
Acquiring ﻿ Name
Null
issuBankNm
A
255
Issuing ﻿ Name
Null
paymentExpDt
N
6
QR ﻿ Expiry Date (YYYYMMDD)
Null
paymentExpTm
N
6
QR ﻿ Expiry Time (HH24MISS)
Null
cancelTrxSn
AN
32
Cancel Transaction Number
Null
userId
AN
128
﻿﻿ User ID Hash
Null
shopId
AN
32
Shop ID
Null
﻿
Additional Response Parameter for Payloan 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 Payloan Status Inquiry 
﻿
JSON Request
JSON Response
Java Request
{
    "tXid": "PAYLOANTES06202212051018325178",
    "iMid": "PAYLOANTES",
    "currency": "IDR",
    "amt": "10000",
    "instmntMon": "1",
    "instmntType": "2",
    "referenceNo": "ORD12345",
    "goodsNm": "Test Transaction Nicepay",
    "payMethod": "06",
    "billingNm": "John Doe",
    "reqDt": "20221205",
    "reqTm": "101832",
    "status": "9",
    "resultCd": "0000",
    "resultMsg": "init",
    "cardNo": null,
    "preauthToken": null,
    "acquBankCd": null,
    "issuBankCd": null,
    "vacctValidDt": null,
    "vacctValidTm": null,
    "vacctNo": null,
    "bankCd": null,
    "payNo": null,
    "mitraCd": "KDVI",
    "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": "PAYLOANTES06202212051018325178",
    "iMid": "PAYLOANTES",
    "currency": "IDR",
    "amt": "10000",
    "instmntMon": "1",
    "instmntType": "2",
    "referenceNo": "ORD12345",
    "goodsNm": "Test Transaction Nicepay",
    "payMethod": "06",
    "billingNm": "John Doe",
    "reqDt": "20221205",
    "reqTm": "101832",
    "status": "9",
    "resultCd": "0000",
    "resultMsg": "init",
    "cardNo": null,
    "preauthToken": null,
    "acquBankCd": null,
    "issuBankCd": null,
    "vacctValidDt": null,
    "vacctValidTm": null,
    "vacctNo": null,
    "bankCd": null,
    "payNo": null,
    "mitraCd": "KDVI",
    "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
}
﻿
﻿

API End Point	/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)	20221114114338
tXid Required	AN	30	Transaction ID	PAYLOANTES06202212051018325178
iMid Required	AN	10	ID	PAYLOANTES
referenceNo Required	ANS	40	Order Number	ORD12345
amt Required	N	12	Transaction Amount	10000
merchantToken Required	AN	255	token	3a04d0c8581ae37727f87130a0b32f2fe9fe39c66b88347352e7b90aeb5cb6e6

Parameter	Type	Size	Description	Example / Notes
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	init
tXid	AN	30	Transaction ID	PAYLOANTES06202212051018325178
iMid	AN	10	ID	PAYLOANTES
referenceNo	ANS	40	Reference Number	ORD12345
payMethod	N	2	Payment Method Code	06
amt	N	12	Amount	10000
CancelAmt	N	12	Cancel Amount	Null
reqDt	N	8	Transaction Request Date (YYYYMMDD)	20221205
reqTm	N	6	Transaction Request Time (HH24MISS)	101832
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	9
instmntMon	N	2	Installment Month	1
instmntType	N	2	Installment Type Code	2
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)	Null
vacctValidTm	N	6	VA Expiry Time (HH24MISS)	Null
vacctNo	N	20	VA Number	Null
bankCd	A	4	Bank Code	Null
payNo	N	12	Number	Null
mitraCd	A	4	Mitra Code	KDVI
receiptCode	ANS	20	Authorization Number	Null
cancelAmt	N	12	Cancel Amount	Null
recurringToken	AN	255	Recurring Token (Needed for Recurring )
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	Expiry (YYMM)	Null
acquBankNm	A	255	Acquiring Name	Null
issuBankNm	A	255	Issuing Name	Null
paymentExpDt	N	6	QR Expiry Date (YYYYMMDD)	Null
paymentExpTm	N	6	QR Expiry Time (HH24MISS)	Null
cancelTrxSn	AN	32	Cancel Transaction Number	Null
userId	AN	128	User ID Hash	Null
shopId	AN	32	Shop ID	Null

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 ()

Payment - API Payloan

Notification - API Payloan

Status Inquiry - API Payloan

About API Payloan Status Inquiry

API Payloan Status Inquiry

Request Parameter for Payloan Status Inquiry

Response Parameter for Payloan Status Inquiry

Additional Response Parameter for Payloan Status Inquiry

Sample JSON for Payloan Status Inquiry

Welcome to NICEPAY DOCS