NICEPAY API
...
API Version 2 (V2)
Advance API

Inquiry List API

17min

List Inquiry API



About List Inquiry API

This uses to get a list of s based on Seller ID msId

API End Point

/nicepay/direct/v2/listInquiry

Request Method application/json

POST

Header

Content-Type: application/json

Merchant Token

SHA256 ( timeStamp + iMid + Merchant Key)



Request Parameter for List Inquiry



Parameter

Type

Size

Description

Example / Notes

timeStamp

Required

N

14

 Request Date

20170708123456

msId

Required

AN

30

 Seller Id

123

iMid

Required

AN

10

 ID

IONPAYTEST

payMethod

Required

AN

40

05

fromDt

Required

N

8

Query Start Date

20191201

toDt

Required

N

8

Query End Date

20191231

merchantToken

Required

AN

64

 Token

46a8219f2e5a903252bb173608ca4324cb25b964d0208625a2ea5 79b385d264a



Response Parameter for List Inquiry



Parameter

Type

Size

Description

Example / Notes

resultCd

N

4

0000

resultMsg

AN

255

Result Message: Error Code

SUCCESS

tXid

AN

30

Transaction ID

IONPAYTEST05201912022223379276

referenceNo

ANS

40

 Order Number

ord20191202221283

amt

N

12

Amount

11000

fee

N

12

Fee



reqDt

N

8

Transaction Request Date

(YYYYMMDD)

20160301

reqTm

N

6

Transaction Request Time (HH24MISS)

135959

transDt

N

8

Transaction Date (YYYYMMDD)

20160303

transTm

N

6

Transaction Time (HH24MISS)

135959

goodsNm

AN

100

Goods Name

Test Transaction

billingNm

A

100

Billing Name

 Name

status

N

1

Transaction Status

0: Approved

3: Request

4: Cancel

8: Timeout

9: Failed

5: Reject before Approved







Sample JSON for List Inquiry API


Request
Response




Inquiry Detail API



About Inquiry Detail API

This uses to check of batch s.

API End Point

/nicepay/direct/v2/InquiryDetail

Request Method

POST

Header

Content-Type: application/json

Merchant Token

SHA256 (timeStamp + iMid + referenceNo+ amt + merchantKey)



Request Parameter for Inquiry Detail



Parameter

Type

Size

Description

Example / Notes

timeStamp

Required

N

14

 Request Date

20180810152800

tXid

Required

AN

30

Transaction ID

BMRITEST0101201808101526233736

iMid

Required

AN

10

 ID

BMRITEST01

referenceNo

Required

ANS

40

 Order Number

OrdNo2018715255268

amt

Required

N

12

Transaction Amount

1000

merchantToken

Required

AN

255

 Token

5a859cf700880565ef7f69218c0efce5bd601766d7bb479e2302f74fdeb95c74



Response Parameter for Inquiry Detail



Parameter

Type

Size

Description

Example / Notes

count

N

12

Transaction Count

3

transactions

AOO



Transaction List

JSON Array

acquirerData

Array

20

A dynamic array consisting of a unique reference number RRN that is provided by ing when a refund is ed. This reference number can be used by to track of refund with .

"acquirerData": { "rrn": "2399849" }



Sample JSON for Inquiry Detail API


Request
Response




Transaction List



Parameter for Transaction List

Parameter

Type

Size

Description

Example / Notes

resultCd

N

4

000

resultMsg

AN

255

Result Message: Error Code

SUCCESS

tXid

AN

30

Transaction ID (Key from )

BMRITEST0101201808101526233736

iMid

AN

10

 ID

BMRITEST01

referenceNo

ANS

40

 Order Number (Key from )

OrdNo2018715255268

payMethod

N

2

01:

amt

N

12

 Amount

1000

currency

AN

3

Currency

IDR

reqDt

N

8

Transaction Request Date (YYYYMMDD)

20160301

reqTm

N

6

Transaction Request Time (HH24MISS)

135959

transDt

N

8

Transaction Date (YYYYMMDD)

20160303

transTm

N

6

Transaction Time (HH24MISS)

135959

goodsNm

AN

100

Goods Name

 Goods 1

billingNm

AN

100

Buyer name

HongGilDong

billingPhone

N

15

Buyer Phone

021-579-00000

billingEmail

ANS

40

Buyer E-mail

no-reply@ionpay.net

billingAddr

AN

100

Buyer Address

Jalan Jenderal Gatot Subroto Kav.57

billingCity

A

50

Buyer City

Jakarta

billingState

A

50

Billing State

Jakarta

billingPostCd

N

10

Billing Post Number

12950

billingCountry

A

10

Billing Country

ID

deliveryNm

A

30

Delivery Name

HongGilDong

deliveryPhone

N

15

Delivery Phone

62-21-0000-0000

deliveryAddr

AN

100

Delivery Address

Jalan Jenderal Gatot Subroto Kav.57

deliveryCity

A

50

Delivery City

Jakarta

deliveryState

A

50

Delivery State

Jakarta

deliveryPostCd

N

10

Delivery Post Code

12950

deliveryCountry

A

10

Delivery Country

ID

bankCd

AN

4

Bank Code

BMRI

status

N

1

Transaction Status

0: Paid

1: Void

2: Refund

3: Unpaid

4: Expired (VA, CVS, Direct Debit-cancel)

8: Fail (refer Status Code)

0

eciValue

N

2

Card ECI

05

issuBankCd

A

4

BMRI

acquBankCd

A

4

BMRI

cardNo

AN

20

Card Number with Masking

483574**9802

cardExpYymm

N

4

Card Expiry (YYMM)

2110

instmntMon

N

2

Installment Month

1

instmntType

N

2

1

preauthToken

AN

255

Pre-Auth Token (need for capture for PREAUTH only)

Ty23revc85452geg46hw33aaca6d17a33e4ad72cfc7c4c656hjt4

recurringToken

AN

255

Recurring Token (Can use next for RECURRING only)

412707a41c69e3142a3ce1d99a09afbf0b8bcd9513f1726e09aabe2e5a3ddd

receiptCode

N

6

Receipt Code

null

ccTransType

AN

2

1: Normal

2: Recurring

3: Pre-Auth

4: Capture

1

acquStatus

AN

2

Purchase Status

00: Not Purchase

01: Later Cancel Not Purchase

10: Finish Purchase

99: etc

00

vat

N

12

Vat

null

fee

N

12

Service Fee

null

notaxAmt

N

12

Tax Free Amount

null

depositDt

N

8

Transaction Request Date (YYYYMMDD)

null

depositTm

N

6

Transaction Request Time (HH24MISS)

null

depositAmt

N

20

Deposit Amount

null

paymentExpDt

N

6

 Expiry Date (YYYYMMDD)

null

paymentExpTm

N

6

 Expiry Time (HH24MISS)

null

paymentTrxSn

N

32

QR Expiry Date (YYYYMMDD)

null

cancelTrxSn

AN

32

Cancel Transaction Number

null

cancelAmt

N

12

Cancel Amount

null

userId

AN

128

User ID Hash

null

shopId

AN

32

Shop ID

null

partialFlag

A

4

Partial Flagging

null

cancelReferenceNo

ANS

40

Cancel Reference Number

null

mitraCd

A

4

Mitra Code

null

mRefNo

AN

20

 Reference Number

null



Sample JSON Array for Transaction List


JSON