NICEPAY API
API Version 1 (V1)

V1 Check Transaction Status

11min

About V1 Check Transaction Status



This

 is intends to check


of


.

  • When a
    
    received on
    
    dbProcessUrl,
    
    strongly recommend
    
    to verify
    
    
    using
    
    V1 Check Transaction Status.
  • When callbackurl is received, we strongly recommend
    
    to verify
    
    
    by using
    
    V1 Check Transaction Status.
  • CallBack Handling is very helpful to minimize Fraud actions, we strongly recommend
    
    s to verify
    
    CallBack Handling.

CallBack Handling Flow

CallBack Handling Flow
CallBack Handling Flow


Steps description :

  1. 
    
    do
    
    .
  2. 
    
    request
    
    to
    
    .
  3. 
    
    send response CallBack and
    
    Result (callBackUrl) to
    
    .
  4. 
    
    check
    
    
    .
  5. 
    
    send
    
    
    to
    
    .
  6. 
    
    return response (Final Status Flag) to
    
    .



API Check Transaction Status



API Endpoint

/nicepay/api/onePassStatus.do

Request Method application/x-www-form-urlencoded

POST

Description

Inquires



to

server.

Merchant Token

SHA256(iMid+referenceNo+amt+merchantKey)

Notification Handling it is very helpful to minimize Fraud actions, we strongly recommend

s to verify

Notification Handling.

Notification Handling Flow

Notification Handling Flow
Notification Handling Flow


Steps description:

  1. 
    
    do
    
    .
  2. 
    
    send
    
    to
    
    .
  3. 
    
    send Notification URL (dbProcessUrl) to
    
    .
  4. 
    
    check
    
    
    .
  5. 
    
    send
    
    
    to
    
    .
  6. 
    
    return response (final
    
    flag) to
    
    .



Request Parameters - Check Status

Check Status - Request Parameter


Parameter

Type

Size

Description

Example / Notes

iMid

Required

AN

10



 ID

IONPAYTEST

merchantToken

Required 

AN

255



 Token

6cfccfc0046773c1b89d8e98c...

tXid Required 

AN

30

Transaction ID

IONPAYTEST02201607291027025291

amt Required 

N

12

Goods Amount

15000

referenceNo Required

ANS

40



 Order Number

OrdNo123124



Response Object - Check Status

Check Status - Response Parameter


Parameter

Type

Size

Description

resultCd

N

4

Result Code

resultMsg

AN

255

tXid

AN

30

Transaction ID

referenceNo

ANS

40



 Reference Number

payMethod

N

2

amt

N

12



 Amount

reqDt

N

8

Transaction Date (YYYYMMDD)

reqTm

N

6

Transaction Time (HH24MISS)

currency

A

3

Currency

goodsNm

AN

100

Goods Name

billingNm

AN

30

Billing Name

status

N

1

instmntMon

N

2

Installment Month

instmntType

N

2

acquirerData

Array

20

A dynamic array consisting of a unique reference number RRN that is provided by

 Banking

when a refund is

ed. This reference number can be used by


to track


of

refund with


.

Additional Response for Virtual Account

Parameter

Type

Size

Description

vacctValidDt

N

8

VA Validity Date (YYYYMMDD)

vacctValidTm

N

6

VA Validity Time (HH24MISS)

vacctNo

N

16

VA Number

bankCd

A

4

Bank Code

Additional Response for QRIS

Parameter

Type

Size

Description

mitraCd

A

4

Mitra Code (QRIS)

cancelAmt

N

12

Cancel Amount

paymentTrxSn

AN

32



 Transaction Number

paymentExpDt

N

6

QR

 Expired Date (YYYYMMDD)

shopId

AN

32

Shop ID

transTm

N

6

Transaction Time (HH24MISS)

paymentExpTm

N

6

QR

 Expired Time (HH24MISS)

cancelTrxSn

AN

32

Cancel Transaction Number

userId

AN

128



 User ID Hash

transDt

N

8

Transaction Date (YYYYMMDD)

depositDt

N

8

Transaction Deposit (YYYYMMDD)

depositTm

N

6

Transaction Deposit Time (HH24MISS)

Additional Response for Others Payment Method

Parameter

Type

Size

Description

mitraCd

A

4

Mitra Code (CVS, E-Wallet, Payloan)

payNo

N

12



 Number (CVS)

payValidDt

N

8

CVS

 Expired Date (YYYYMMDD)

payValidTm

N

6

CVS

 Expired Time (HH24MISS)

receiptCode

ANS

18

Authorization Number