---
title: Payment - API NICEPAY Inquiry Convenience Store SNAP
slug: nicepay-api-snap-payment-nicepay-inquiry-convenience-store
description: Informasi tentang Payment - API NICEPAY Inquiry Convenience Store SNAP yang terdapat pada sistem NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/5fnk1Unzm66cb5SGzkPSh_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags: 
createdAt: 2025-05-13T03:01:15.585Z
---

# Tentang Payment - 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) yang memberikan kebebasan untuk Merchant menyimpan data Pelanggan dan membuat nomor Convenience Store sendiri di sistemnya selama masih mengikuti ketentuan pembuatan nomor CVS dari NICEPAY.



# Payment - API NICEPAY Inquiry Convenience Store SNAP

:::hint{type="warning"}
Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian [Request Access Token - API NICEPAY Inquiry Convenience Store SNAP](docId\:Bo7josDlhHB-_TMdE6TGS).
:::

| **API Endpoint** | `https://[merchant-domain]/api/v.1.0/cvs/payment` |
| ---------------- | ------------------------------------------------- |
| **Method**       | `POST`                                            |
| **Description**  | Untuk melakukan pembayaran transaksi NICO
    |
| **Content-type** | `application/json`                                |

:::hint{type="info"}
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 Payment 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`<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**         | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi**                               |
| --------------------- | -------- | ---------- | ------------- | ------------------------------------------- |
| `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**         | **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                                 |
| `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"
  }
}
```
:::