Inquiry - API NICEPAY Inquiry Convenience Store SNAP
Tentang Inquiry - API NICEPAY Inquiry Convenience Store SNAP
Bagian ini berisi tentang informasi terkait API dengan standar SNAP yang digunakan pada metode pembayaran Convenience Store dengan fitur NICEPAY Inquiry Convenience Store (NICO) agar dapat memeriksa status transaksi.
Inquiry - API NICEPAY Inquiry Convenience Store SNAP
Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian 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 status transaksi NICO |
Content-type | application/json |
Pada saat melakukan proses integrasi, NICEPAY akan mengirimkan Public Key kepada Merchant. Kemudian, Merchant wajib memberi informasi terkait endpoint API Inquiry CVS dan mengirimkan Client ID & Client Secret sesuai dengan spesifikasi NICEPAY kepada tim NICEPAY.
Hal tersebut perlu dilakukan agar NICEPAY dapat mengajukan akses token dan melakukan inquiry data Pelanggan yang berada di sisi Merchant. Sehingga, proses pembayaran dapat dijalankan dengan lancar oleh Pelanggan Anda.
Request Inquiry Transaction Header Parameter
Parameter | Tipe | Kebutuhan | Deskripsi | Contoh |
|---|---|---|---|---|
Content-Type | String | Mandatory | String Media Type of the Resource | application/json |
Authorization | String | Mandatory | Access Token Transaction | Bearer "accessToken" |
X-TIMESTAMP | String | Mandatory | NICEPAY Timezone | YYYY-MM-DDTHH:MM:SS (2024-01-22T15:00:01+07:00) |
X-PARTNER-ID | String | Mandatory | Merchant ID | IONPAYTEST |
X-SIGNATURE | String | Mandatory | NICEPAY Signature | Generated by Partner/Merchant 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 transaction | 11245542345212 |
CHANNEL-ID | String | Mandatory | Device identification on which the API service s | IONPAYTEST |
Request Inquiry Transaction Body Parameter
Parameter | Tipe | Ukuran | Kebutuhan | Deskripsi |
|---|---|---|---|---|
partnerServiceId | String | 4 | Mandatory | Prefix |
customerNo | String | 8 | Mandatory | Customer Number |
payNo | String | 12 | Mandatory | payNo Number |
inquiryRequestId | String | 40 | Mandatory | Unique Identifier from NICEPAY |
mitraCd | String | 4 | Mandatory |
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 | Customer 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 NICEPAY |
totalAmount | Object | | Mandatory | Total Amount |
value | Number | 12 | Mandatory | Value |
currency | String | 3 | Mandatory | Currency |
partnerReferenceNo | String | 40 | Mandatory | Merchant Reference Number |
mitraCd | String | 4 | Mandatory | |
payNoExpiredDateTime | String | 25 | Mandatory | payNo Expired Date Time |
Sample Parameter
{
"partnerServiceId": "7015",
"customerNo": "89101110",
"payNo": "701589101110",
"inquiryRequestId": "41807553358950093184",
"mitraCd": "ALMA"
}