---
title: Inquiry - API NICEPAY Inquiry Virtual Account SNAP
slug: nicepay-api-snap-inquiry-nicepay-inquiry-virtual-account
description: Informasi tentang Inquiry - API NICEPAY Inquiry Virtual Account SNAP yang terdapat pada sistem NICEPAY
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/fKHr8WyqT9FzBOge-Inyz_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2023-06-26T03:03:10.602Z
---
# Tentang Inquiry - API NICEPAY Inquiry Virtual Account SNAP
***
Bagian ini berisi tentang informasi terkait API dengan standar SNAP yang digunakan pada metode pembayaran Virtual Account dengan fitur NICEPAY Inquiry Virtual Account (NIVA) agar dapat memeriksa status transaksi*.*
# Inquiry - API NICEPAY Inquiry Virtual Account SNAP
***
:::hint{type="warning"}
Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian [Request Access Token - API NICEPAY Inquiry Virtual Account SNAP](docId\:tbDHyMKVQK7C20nUkjB0N).
:::
| **Service Code** | `24` |
| ---------------- | ------------------------------------------------------ |
| **API Endpoint** | `[merchant-domain]/api/v1.0/transfer-va/inquiry` |
| **Method** | `HTTP` `POST` |
| **Description** | Untuk melakukan pemeriksaan status transaksi NIVA
|
| **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 VA 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 Header Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** | **Contoh** |
| --------------- | -------- | ---------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `Content-Type` | String | | Mandatory | `Application / JSON` | |
| `Authorization` | String | | Mandatory | Bearer “`access_token`” | |
| `X-TIMESTAMP` | String | | Mandatory | Using ISO 8601 as timestamp format.
Transaction date time, in format `YYYYMMDDTHH:mm:ss+07:00`.
Time must be in GMT+7 (Jakarta time).
`2022-03-21T10:11:40+07:00`. | |
| `X-SIGNATURE` | String | | Mandatory | Signature will be generated by Merchant.
[Panduan X-Signature - Symmetric](docId\:UZex33ReLyENKOgbJJnYp) | |
| `X-PARTNER-ID` | String | 20 | Mandatory | `X-PARTNER-ID` = `CLIENT_ID` | |
| `X-EXTERNAL-ID` | String | 40 | Mandatory | Unique Reference Number
(`41807553358950093184`) | |
| `CHANNEL-ID` | String | | Mandatory | Unique Channel Merchant Credential ID Number.
Client ID + "01" = Channel ID
`"IONPAYTEST" + "01" = "IONPAYTEST01"` | IONPAYTEST01 |
## Request Inquiry Body Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** |
| ------------------ | -------- | ---------- | ------------- | ----------------------------------------------------------------- |
| `partnerServiceId` | String | 20 | Mandatory | Partner Service
ID / Prefix |
| `customerNo` | String | 40 | Mandatory | Customer Number |
| `virtualAccountNo` | String | 25 | Mandatory | Virtual Account Number |
| `inquiryRequestId` | String | 40 | Mandatory | Unique Identifier for this Inquiry |
| `additionalInfo` | Object | | Mandatory | `"additionalInfo": {
`
` ...
`
` }` |
| `bankCd` | String | 4 | Mandatory | [Bank Code - API SNAP](docId:9WOQy5-1hlf_uCwshSDHO) |
## Response Inquiry Parameter
| **Parameter** | **Tipe** | **Ukuran** | **Kebutuhan** | **Deskripsi** |
| -------------------- | -------- | ---------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `responseCode` | String | | Mandatory | [General Response Code and Message - API SNAP](docId\:lKqJXSl5CMKdXYXxHYYSs) |
| `responseMessage` | String | | Mandatory | Response Message |
| `virtualAccountData` | Object | | Mandatory | `"virtualAccountData": {
`
` "partnerServiceId": "70151021",
`
` "customerNo": "89101110",
`
` "virtualAccountNo": "7015102189101110",
`
` "virtualAccountName": "John Test",
`
` "inquiryRequestId": "41807553358950093184",
`
` "totalAmount": {
`
` ....
`
` }
`
` },` |
| `partnerServiceId` | String | 20 | Mandatory | Partner Service ID / Prefix |
| `customerNo` | String | 40 | Mandatory | Customer Number (Mandatory for Fix Type) |
| `virtualAccountNo` | String | 25 | Mandatory | Virtual Account Number |
| `virtualAccountName` | String | 100 | Mandatory | Virtual Account Name |
| `inquiryRequestId` | String | 40 | Mandatory | Unique Identifier for this Inquiry |
| `totalAmount` | Object | | Mandatory | `"totalAmount": {
`
` ....
`
` }` |
| `value` | String | 12 | Mandatory | Value |
| `currency` | String | 3 | Mandatory | Currency |
| `additionalInfo` | Object | | Mandatory | `"additionalInfo": {
`
` ...
`
` }` |
| `trxId` | String | 40 | Mandatory | Merchant Order Number |
| `goodsNm` | String | 200 | Mandatory | Goods Name |
## Sample Parameter
:::CodeblockTabs
Sample Request
```json
//HEADER SECTION
Content-Type: application/json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJJT05QQVlURVNUIiwiaXNzIjoiTklDRVBBWSIsIm5hbWUiOiJCUklOIiwiZXhwIjoiMjAyNC0wMi0xMVQwODowOTozNVoifQ==.aIybLX36dYwfFvW7dcoenXkOe2EAwIYq84ZtPuIf3K8=
X-TIMESTAMP: 2024-12-31T10:11:40+07:00
X-SIGNATURE: ufBw7R8RhW79IOiV/Hlv607M60qzAYBv8uZmbSrYb6/Thlo/FhQVP4xRyelUehoSS9o+QS6vWTKb/ygtucC+tQ==
X-PARTNER-ID: FIXOPEN001
X-EXTERNAL-ID: tXid202402111402271707638114
CHANNEL-ID: FIXOPEN001
{
"partnerServiceId": "70151021",
"customerNo": "89101110",
"virtualAccountNo": "7015102189101110",
"inquiryRequestId": "41807553358950093184",
"additionalInfo": {
"bankCd": "BMRI"
}
}
```
Sample Response
```json
{
"responseCode": "2002400",
"responseMessage": "Success",
"virtualAccountData": {
"partnerServiceId": "70151021",
"customerNo": "89101110",
"virtualAccountNo": "7015102189101110",
"virtualAccountName": "John Test",
"inquiryRequestId": "41807553358950093184",
"totalAmount": {
"value": "10000.00",
"currency": "IDR"
}
},
"additionalInfo": {
"trxId": "ref100000001",
"goodsNm": "Test Item"
}
}
```
:::