---
title: Payment - API NICEPAY Inquiry Convenience Store SNAP
slug: en/nicepay-api-snap-payment-nicepay-inquiry-convenience-store
description: Information about Payment - API NICEPAY Inquiry Convenience Store SNAP available on the NICEPAY system
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/YnwL7b0mBAauYWu18Xw3l_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags: 
createdAt: 2025-05-19T07:51:35.371Z
---

# About Payment - API NICEPAY Inquiry Convenience Store SNAP

***

This API with SNAP standard contains information used on the Convenience Store payment method with the NICEPAY Inquiry Convenience Store (NICO) feature, which allows Merchants to store Customer's data and generate their own Virtual Account numbers within their system, provided they adhere to NICEPAY’s Virtual Account creation guidelines.



# Payment - API NICEPAY Inquiry Convenience Store SNAP

:::hint{type="warning"}
Please request the access token firsthand before doing the authentication through the [Request Access Token - API NICEPAY Inquiry Convenience Store SNAP](docId:-tOJMSJfROpBM5ROD4lCu)   section.
:::

| **API Endpoint** | `https://[merchant-domain]/api/v.1.0/cvs/payment` |
| ---------------- | ------------------------------------------------- |
| **Method**       | `POST`                                            |
| **Description**  | To proceed the NICO transaction status 
      |
| **Content-type** | `application/json`                                |

:::hint{type="info"}
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 Payment 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`<br />(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 <br />created using asymmetric<br />signature SHA256withRSA algorithm<br />(`Private_Key`, `stringToSign`)<br />`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 Payment 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                              |
| `payNoName`           | String   | 100        | Mandatory    | `payNo` Name                                |
| `goodsName`           | String   | 200        | Mandatory    | Goods Name                                  |
| `payNoPhone`          | String   | 15         | Mandatory    | `payNo` Phone                               |
| `payNoEmail`          | String   | 100        | Mandatory    | `payNo` Email                               |
| `partnerReferenceNo`  | String   | 40         | Mandatory    | Merchant  Reference Number                  |
| `paymentRequestId`    | String   | 30         | Mandatory    | TXID (Transaction ID Generated by NICEPAY)  |
| `paidAmount`          | String   |            | Mandatory    | Paid Amount                                 |
| `value`               | String   | 12         | Mandatory    | Transaction Amount                          |
| `currency`            | String   | 3          | Mandatory    | Currency                                    |
| `transactionDateTime` | String   | 25         | Mandatory    | Transaction Date Time                       |
| `mitraCd`             | String   | 4          | Mandatory    | [Mitra Code](docId\:Tm257gq3DxgZf98uZ0l33)  |



## Response Payment 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                               |
| `partnerReferenceNo`  | String   | 40         | Mandatory    | Merchant Reference Number                   |
| `paymentRequestId`    | String   | 30         | Mandatory    | TXID (Transaction ID Generated by NICEPAY)  |
| `paidAmount`          | Object   |            | Mandatory    | Paid Amount                                 |
| `value`               | String   | 12         | Mandatory    | Transaction Amount                          |
| `currency`            | String   | 3          | Mandatory    | Currency                                    |
| `transactionDateTime` | String   | 25         | Mandatory    | Transaction Date Time                       |
| `mitraCd`             | String   | 4          | Mandatory    | [Mitra Code](docId\:Tm257gq3DxgZf98uZ0l33)  |



## Sample Parameter

:::CodeblockTabs
JSON Request

```json
{
  "partnerServiceId": "7015",
  "customerNo": "89101110",
  "payNo": "701589101110",
  "payNoName": "John Test",
  "goodsName": "Pembelian John Test",
  "payNoPhone": "087771122333",
  "payNoEmail": "jhon@test.com",
  "partnerReferenceNo": "abcdefgh1234",
  "paymentRequestId": "IONPAYTEST03202212021529034686",
  "paidAmount": {
    "value": "10000.00",
    "currency": "IDR"
  },
  "transactionDateTime": "2014-07-03T12:08:56+07:00",
  "mitraCd": "ALMA"
}
```

JSON Response

```json
{
  "responseCode": "2000000",
  "responseMessage": "Successful",
  "payNoData": {
    "partnerServiceId": "7015",
    "customerNo": "89101110",
    "payNo": "701589101110",
    "payNoName": "John Test",
    "payNoPhone": "087771122333",
    "payNoEmail": "jhon@test.com",
    "partnerReferenceNo": "abcdefgh1234",
    "paymentRequestId": "IONPAYTEST03202212021529034686",
    "paidAmount": {
      "value": "100000.00",
      "currency": "IDR"
    },
    "transactionDateTime": "2019-07-03T12:08:56+07:00",
    "mitraCd": "ALMA"
  }
}
```
:::