Inquiry - API NICEPAY Inquiry Convenience Store SNAP
About Inquiry - API NICEPAY Inquiry Convenience Store SNAP
This API with SNAP standard contains information uses on the Convenience Store payment method with the NICEPAY Inquiry Convenience Store (NICO) feature for requesting a token to proceed with the transaction.
Inquiry - API NICEPAY Inquiry Convenience Store SNAP
Please request the access token firsthand before doing the authentication through the Request Access Token - API NICEPAY Inquiry Convenience Store SNAP section.
API Endpoint | https://[merchant-domain]/api/v.1.0/cvs/inquiry |
|---|---|
Method | POST |
Description | To proceed the NICO transaction status |
Content-type | application/json |
When proceeding with the integration process, NICEPAY will send a Public Key to the Merchant. The Merchant must then provide the API CVS Inquiry endpoint details and submit the Client ID & Client Secret in accordance with NICEPAY’s specifications.
This step is necessary so that NICEPAY can request an access token and proceed with the Customer data inquiry on the Merchant’s side. As a result, Customers can complete the payment process seamlessly.
Request Inquiry Transaction Header Parameter
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
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 | Type | Length | Required | Description |
|---|---|---|---|---|
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 | Type | Length | Required | Description |
|---|---|---|---|---|
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
{
"responseCode": "2000000",
"responseMessage": "Successful",
"payNoData": {
"partnerServiceId": "7015",
"customerNo": "89101110",
"payNo": "701589101110",
"payNoName": "John Test",
"goodsName": "Pembelian John Test",
"payNoPhone": "087771122333",
"payNoEmail": "[email protected]",
"inquiryRequestId": "41807553358950093184",
"totalAmount": {
"value": "10000.00",
"currency": "IDR"
},
"partnerReferenceNo": "abcdefgh1234",
"mitraCd": "ALMA",
"payNoExpiredDateTime": "2024-07-03T12:08:56+07:00"
}
}