NICEPAY API
...
Payment API
API GPN

Status Inquiry - API GPN

10min

About API GPN Status Inquiry



Integration of Status Inquiry on is required so that s can check current of carried out by whether is success, fail, and others. So that can have a report on that .



API GPN Status Inquiry



The of Inquiry Status on aims to allow s to connect with to check of on a regular basis.

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 encourage s to verify using Status Inquiry - API GPN.

Notification Handling is very useful to minimize occurrence of Fraud. We strongly encourage s to verify Notification Handling. You can read more detailed about Notification Handling on Notification - API GPN.



Request Parameter for GPN 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)

20221114114338

tXid Required 

AN

30

Transaction ID

IONPAYTEST01202212071629087180

iMid

Required 

AN

10

 ID

IONPAYTEST

referenceNo Required 

ANS

40

 Order Number

815123412341

amt Required 

N

12

Transaction Amount

10000

merchantToken Required 

AN

255

 Token

4b11d820b0d2ef509715e7b923430643416efc0df4ca2ba2d4b66eb549e074bd



Response Parameter for GPN Status Inquiry



The following is a list of responses to request inquiry on .

Parameter

Type

Size

Description

Example / Notes

resultCd

N

4

0000

resultMsg

AN

255

Result Message: Error Code

paid

tXid

AN

30

Transaction ID

IONPAYTEST01202212071629087180

iMid

AN

10

 ID

IONPAYTEST

referenceNo

ANS

40

 Reference Number

815123412341

payMethod

N

2

09

amt

N

12

 Amount

10000

CancelAmt

N

12

Cancel Amount

null

reqDt

N

8

Transaction Request Date (YYYYMMDD)

20221207

reqTm

N

6

Transaction Request Time (HH24MISS)

162908

transDt

N

8

Transaction Date (YYYYMMDD)

20221207

transTm

N

6

Transaction Time (HH24MISS)

162908

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

0

instmntType

N

2

1

instmntMon

N

2

Installment Month

1

cardNo

N

20

Card Number

62210082****0590

preauthToken

AN

64

Pre-Auth Token

null

issuBankCd

A

4

OTHR

acquBankCd

A

4

BNIN

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

null

receiptCode

ANS

20

Authorization Number

null

recurringToken

AN

255

Recurring Token (Needed for Recurring )

null

ccTransType

N

2

1

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

Status Acquiring

20

cardExpYymm

N

4

Expiry (YYMM)

2612

acquBankNm

A

255

Acquiring Name

BNI

issuBankNm

A

255

Issuing Name

OTHER

paymentExpDt

N

6

QR Expiry Date (YYYYMMDD)

null

paymentExpTm

N

6

QR Expiry Time (HH24MISS)

null

paymentTrxSn

AN

32

 Transaction Number

null

cancelTrxSn

AN

128

Cancel Transaction Number

null

userId

AN

128

 User ID Hash

null

shopId

AN

32

Shop ID

null



Additional Response Parameter for Others Status Inquiry



The following is additional response list from request inquiry in other es.

Parameter

Type

Size

Description

Example / Notes

mitraCd

A

4

(CVS, , , )

null

payNo

N

12

CVS Number (CVS)

null

payValidDt

N

8

CVS Expiry Date (YYYYMMDD) (CVS)

null

payValidTm

N

6

CVS Expiry Time (HH24MISS) (CVS)

null

receiptCode

ANS

20

Authorization Code (CVS)

null

mRefNo

AN

20

 Reference Number ()

nul

Sample JSON for GPN Status Inquiry


JSON Request
JSON Response
Java Request