NICEPAY API
...
API NICEPAY Inquiry Convenienc...

Inquiry - API NICEPAY Inquiry Convenience Store SNAP

8 min

Tentang Inquiry - API NICEPAY Inquiry Convenience Store SNAP



Bagian ini berisi tentang  terkait  dengan standar   digunakan pada   dengan fitur  Inquiry  (NICO) agar dapat memeriksa  .



Inquiry - API NICEPAY Inquiry Convenience Store SNAP



 mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui  Request Access Token - API NICEPAY Inquiry Convenience Store SNAP.

API Endpoint

https://[merchant-domain]/api/v.1.0/cvs/inquiry

Method

POST

Description

Untuk melakukan pemeriksaan   NICO

Content-type

application/json

Pada saat melakukan  ,  akan mengirimkan Public Key kepada . Kemudian,  wajib memberi  terkait endpoint  Inquiry CVS dan mengirimkan Client ID & Client Secret sesuai dengan spesifikasi  kepada tim .

Hal tersebut perlu dilakukan agar  dapat mengajukan akses token dan melakukan inquiry data   berada di sisi . Sehingga,   dapat dijalankan dengan lancar oleh  .



Request Inquiry Transaction Header Parameter

Parameter

Tipe

Kebutuhan

Deskripsi

Contoh

Content-Type

String

Mandatory

String Media Type of  Resource

application/json

Authorization

String

Mandatory

Access Token Transaction

Bearer "accessToken"

X-TIMESTAMP

String

Mandatory

 Timezone

YYYY-MM-DDTHH:MM:SS

(2024-01-22T15:00:01+07:00)

X-PARTNER-ID

String

Mandatory

 ID

IONPAYTEST

X-SIGNATURE

String

Mandatory

 Signature

Generated by /

created using asymmetric signature SHA256withRSA algorithm (Private_Key, stringToSign) stringToSign = client ID + “|” + X-TIMESTAMP

X-EXTERNAL-ID

String

Mandatory

Reference Number that should be unique in every 

11245542345212

CHANNEL-ID

String

Mandatory

Device identification on which    s

IONPAYTEST



Request Inquiry Transaction Body Parameter

Parameter

Tipe

Ukuran

Kebutuhan

Deskripsi

partnerServiceId

String

4

Mandatory

Prefix

customerNo

String

8

Mandatory

 Number

payNo

String

12

Mandatory

payNo Number

inquiryRequestId

String

40

Mandatory

Unique Identifier from 

mitraCd

String

4

Mandatory

Mitra Code



Response Inquiry Transaction Body Parameter

Parameter

Tipe

Ukuran

Kebutuhan

Deskripsi

responseCode

String

5

Mandatory

Response Code

responseMessage

String

100

Mandatory

Response Message

payNoData

Object



Mandatory

payNo Data

partnerServiceId

String

4

Mandatory

Prefix

customerNo

String

8

Mandatory

 Number

payNo

String

12

Mandatory

payNo Number

payNoName

String

100

Mandatory

payNo Name

goodsName

String

200

Mandatory

Goods Name

payNoPhone

Number

15

Mandatory

payNo Phone

payNoEmail

String

100

Mandatory

payNo Email

inquiryRequestId

String

40

Mandatory

Unique Identifier from 

totalAmount

Object



Mandatory

Total Amount

value

Number

12

Mandatory

Value

currency

String

3

Mandatory

Currency

partnerReferenceNo

String

40

Mandatory

 Reference Number

mitraCd

String

4

Mandatory

Mitra Code

payNoExpiredDateTime

String

25

Mandatory

payNo Expired Date Time



Sample Parameter

JSON Request
JSON Response