---
title: NICEPAY Inquiry Virtual Account
slug: en/nicepay-api-non-snap-nicepay-inquiry-virtual-account
description: Information about Non-SNAP Advance API - NICEPAY Inquiry Virtual Account available on NICEPAY system
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/frYKPdgOm8thX75_f0FSS_nicepay-docs-logo.png
icon: {"faIcon":"fa-solid fa-anchor-lock"}
docTags: 
createdAt: 2022-11-18T06:22:25.000Z
---

# About API NICEPAY Inquiry Virtual Account

***

Bulk integration uses for Virtual Account *NICEPAY Inquiry Virtual Account type* payment method. In this payment method, Merchants maintain Customer data. So, every payment from a Bank, NICEPAY requires Customer data inquiry to the Merchant. Also included for payment confirmation, NICEPAY makes a payment request to the Merchant.



# NICEPAY Inquiry Virtual Account Flow

***



![](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/OJT2u3IojTYOzGRGOaDFd_payment-va-bulk.png "Flow NICEPAY Inquiry Virtual Account")



# Inquiry Process NICEPAY to Merchant

***

This process aims to find out the details of the bill. After NICEPAY gets an inquiry request from the Bank. NICEPAY will call the Merchant service to get detailed Customer data information. Then, the data will be stored in the internal history of the NICEPAY system and sent to the Bank using the inquiry Bank response format.

| **API URL**              | https\:// \< merchant URL for inquiry >                   |
| ------------------------ | --------------------------------------------------------- |
| **Request Method&#x20;** | <font color="#3b9f0f">**POST (Body Raw JSON)**</font>**** |
| **Merchant Token**       | -                                                         |
| **Request Format**       | -                                                         |



## Inquiry Request Parameter&#x20;

***

The following is a list of parameters to proceed the NICEPAY Inquiry process to the Merchant from the executed transaction on Virtual Account's *NICEPAY Inquiry Virtual Account type* payment method. This parameter uses through the API testing platform as one of the stages so that the Merchant's system can connect with services from NICEPAY.

| **Parameter**   | **Type** | **Size** | **Description**                                         | **Example / Notes**                                              |
| --------------- | -------- | -------- | ------------------------------------------------------- | ---------------------------------------------------------------- |
| `customerId`    | N        | 9        | Customer ID                                             | 891011101                                                        |
| `merchantToken` | AN       | 255      | SHA256 (`Merchant ID` + `Customer ID` + `Merchant Key`) | 141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b |
| `prefix`        | N        | 7        | Virtual Account Prefix Number                           | 7015102                                                          |
| `bankCd`        | AN       | 4        | [Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0)               | "CENA                                                            |



## Inquiry Response Parameter&#x20;

***

Following are the response parameters from the results of the request parameters for the NICEPAY to Merchant Inquiry Process.

| **Parameter**    | **Type** | **Size** | **Description**                                                   | **Example / Notes**                           |
| ---------------- | -------- | -------- | ----------------------------------------------------------------- | --------------------------------------------- |
| `billingNm`&#xD; | N        | 100      | Customer Name                                                     | John Doe                                      |
| `goodsNm`        | AN       | 100      | Goods/Item name                                                   | Testing Buying                                |
| `referenceNo`    | N        | 40       | Reference Number for Payment                                      | ordNo20221130101148                           |
| `amt`            | AN       | 12       | Total Bill Amount                                                 | 5000<br /><br />Normal Amount &#xD;<br />Only |
| `resultCd`       | N        | 4        | [Result Code](docId:9eC3yH9CQqpb6cRWauWWO) of Inquiry Status      | 0000                                          |
| `resultMsg`      | AN       | 255      | Result Message for the [Result Code](docId:9eC3yH9CQqpb6cRWauWWO) | SUCCESS                                       |



## Sample JSON Inquiry Process Nicepay to Merchant

***

:::CodeblockTabs
JSON Request

```json
{
    "customerId" : "891011101",
    "merchantToken" : "141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b",
    "prefix" :  "7015102",
    "bankCd" :  "CENA"
}
```

JSON Response

```json
{
    "resultCd" : "0000",
    "resultMsg" : "SUCCESS",
    "billingNm" : "John Doe",
    "goodsNm" : "Testing Buying",
    "referenceNo" : "ordNo20221130101148",
    "amt" : "5000"
}
```

Java Request

```java
//Inquiry To Merchant//
nicePay.setCustomerId("123456");
nicePay.setPrefix("000001");
nicePay.setBankCd("CENA");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getCustomerID());

//Request Inquiry//
nicePay.inquiry();

//Response Inquiry//
String resultCd = nicePay.get("resultCd");
String resultMsg = nicepay.get("resultMsg");
String billingNm = nicePay.get("billingNm");
String referenceNo = nicePay.get("referenceNo");
String goodsNm = nicePay.get("goodsNm");
String amt = nicePay.get("amt");

```
:::



# Payment Process NICEPAY to Merchant

***

*Payment Process NICEPAY to Merchant* is the stage to continue the payment process made by the Customer. When the Bank makes a payment request to NICEPAY using a Virtual Account number, NICEPAY will call the Merchant payment URL service to process the payment. The Merchant determines the payment response to accept or reject payments from Customers.

| **API End Point** | https\:// \< Merchant URL for payment  >                  |
| ----------------- | --------------------------------------------------------- |
| **Method&#x20;**  | <font color="#3b9f0f">**POST (Body Raw JSON)**</font>**** |



## Payment Request Parameter&#x20;

***

The following is a list of parameters for proceed the *NICEPAY to Merchant Payment Process* from transactions made on the Virtual Account's *NICEPAY Inquiry Virtual Account type* payment method. This parameter is used through the API testing platform as one of the stages so that the Merchant's system can be connected to services from NICEPAY.

| **Parameter**   | **Type** | **Size** | **Description**                                                 | **Example / Notes**                                              |
| --------------- | -------- | -------- | --------------------------------------------------------------- | ---------------------------------------------------------------- |
| `customerId`    | N        | 9        | Customer ID                                                     | 110000001                                                        |
| `merchantToken` | AN       | 255      | SHA256 (`Merchant ID` + `Customer ID` + `amt` + `Merchant Key`) | 141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b |
| `referenceNo`   | AN       | 40       | Reference Number From Inquiry                                   | OrdNo202210102323223                                             |
| `prefix`        | N        | 7        | Virtual Account Prefix Number                                   | 7015102                                                          |
| `bankCd`        | AN       | 4        | [Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0)                       | CENA                                                             |
| `amt`           | N        | 12       | Total Bill Amount                                               | 10000                                                            |
| `tXid`          | AN       | 30       | Transaction ID from NICEPAY                                     | NORMALTEST02202211301010513135                                   |



## Payment Response Parameter&#x20;

***

Following are the response parameters from the results of the request parameters for the *NICEPAY to Merchant Payment Process*.

| **Parameter**    | **Type** | **Size** | **Description**                                                   | **Example / Notes**           |
| ---------------- | -------- | -------- | ----------------------------------------------------------------- | ----------------------------- |
| `billingNm`&#xD; | N        | 100      | Customer Name                                                     | John Doe                      |
| `goodsNm`        | AN       | 255      | Goods/Item name                                                   | Testing Buying                |
| `referenceNo`    | N        | 7        | Reference Number for Payment                                      | ordNo2022113010114            |
| `amt`            | AN       | 4        | Total Bill Amount                                                 | Normal amount &#xD;<br />only |
| `resultCd`       |          | 4        | [Result Code](docId:9eC3yH9CQqpb6cRWauWWO) of Inquiry Status      | 0000                          |
| `resultMsg`      | AN       | 255      | Result Message for the [Result Code](docId:9eC3yH9CQqpb6cRWauWWO) | SUCCESS                       |



## Sample JSON Payment Process NICEPAY to Merchant

***

:::CodeblockTabs
JSON Request

```json
{
    "customerId" : "110000001",
    "merchantToken" : "141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b",
    "referenceNo" : "OrdNo202210102323223",
    "prefix" : "7015102",
    "bankCd" : "CENA",
    "amt" : "10000",
    "tXid" : "NORMALTEST02202211301010513135"
}
```

JSON Response

```json
{
    "resultCd" : "0000",
    "resultMsg" : "SUCCESS",
    "billingNm" : "John Doe",
    "goodsNm" : "Testing Buying",
    "referenceNo" : "ordNo20221130101148",
    "amt" : "10000"
}
```

Java Request

```java
{
	merchantToken=b360a7dfd4e004e63a161d7298a006ac7900add126b8e19375c4a594ab2e806e,
	vacctType=1,
	referenceNo=2211JD1X7TX5,
	prefix=70015267,
	proxyUrl=http://172.30.51.31:8080/nicepay_proxy/api/bulkPayment.do,
	customerId=60028392,
	bankCd=BMRI,
	tXid=OYINDON00402202211160002385044,
	amt=150000,
	targetUrl=https://payfeedback.oyindonesia.com/nicepay/va/bulk/payment
}
```
:::



# Reversal Process NICEPAY to Merchant

***

*Reversal Process NICEPAY to Merchant* is a refund process that occurs caused of an issue happen from internal Bank system. In this process, NICEPAY will continue the information status receive from Bank to the Merchant.

| **API End Point** | https\:// \< Merchant URL for reversal>                   |
| ----------------- | --------------------------------------------------------- |
| **Method&#x20;**  | <font color="#3b9f0f">**POST (Body Raw JSON)**</font>**** |



## Process Flow

![](https://api.archbee.com/api/optimize/ZHvSjR5ZrsoxwKbJa3xmo/Szs-r5qOWImlRGewe9dRb_nicepay-archbee-payment-va-reversaldrawio-4.png "Proses Reversal VA ")



## Reversal Request Parameter&#x20;

***

The following is a list of parameters for performing the *NICEPAY to Merchant Reversal Process* from transactions made to the *NICEPAY Inquiry Virtual Account type* Virtual Account payment method. This parameter is used through the API testing platform as one of the stages so that the Merchant's system can connect with services from NICEPAY.

| **Parameter**   | **Type** | **Size** | **Description**                                                 | **Example / Notes**                                              |
| --------------- | -------- | -------- | --------------------------------------------------------------- | ---------------------------------------------------------------- |
| `customerId`    | N        | 9        | Customer ID                                                     | 110000001                                                        |
| `merchantToken` | AN       | 255      | SHA256 (`Merchant ID` + `Customer ID` + `amt` + `Merchant Key`) | 141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b |
| `referenceNo`   | AN       | 40       | Reference Number from Inquiry                                   | OrdNo202210102323223                                             |
| `prefix`        | N        | 7        | Virtual Account Prefix Number                                   | 7015102                                                          |
| `bankCd`        | AN       | 4        | [Bank Code](docId\:HlxvgrXVxWD90n8ohNKm0)                       | CENA                                                             |
| `amt`           | N        | 12       | Total Bill Amount                                               | 10000                                                            |
| `tXid`          | AN       | 30       | Transaction ID from NICEPAY                                     | NORMALTEST02202211301010513135                                   |



## Reversal Response Parameter&#x20;

***

Following are the response parameters from the results of the request parameters for the *NICEPAY to Merchant Reversal Process*.

| **Parameter**    | **Type** | **Size** | **Description**                                                           | **Example / Notes**                                                       |
| ---------------- | -------- | -------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `billingNm`&#xD; | N        | 100      | Customer Name                                                             | John Doe<br /><br />Topup mount &#xD;<br />only&#xD;                      |
| `goodsNm`        | AN       | 100      | Goods/Item Name                                                           | Testing Reversal Transaction<br /><br />Topup amount &#xD;<br />only&#xD; |
| `referenceNo`    | N        | 40       | Reference Number for Payment                                              | OrdNo202210102323223                                                      |
| `amt`            | AN       | 12       | Total Bill Amount                                                         | 50000                                                                     |
| `resultCd`       |          | 34       | Result Code of Inquiry Status [Result Code](docId:9eC3yH9CQqpb6cRWauWWO)  | 0000                                                                      |
| `resultMsg`      |          | 255      | Result Message for the [Result Code](docId:9eC3yH9CQqpb6cRWauWWO)         | SUCCESS                                                                   |



## Sample JSON Reversal Process NICEPAY to Merchant

***

:::CodeblockTabs
JSON Request

```json
{
    "customerId" : "110000001",
    "merchantToken" : "141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b",
    "referenceNo" : "OrdNo202210102323223",
    "prefix" : "7015102",
    "bankCd" : "CENA",
    "amt" : "10000",
    "tXid" : "NORMALTEST02202211301010513135"
}
```

JSON Response

```json
{
    "resultCd" : "0000",
    "resultMsg" : "SUCCESS",
    "billingNm" : "John Doe",
    "referenceNo" : "OrdNo202210102323223",
    "goodsNm" : "Testing Reversal Transaction",
    "amt" : "50000"
}
```

Java Request

```java
//Reversal To Merchant//
nicePay.setCustomerId("123456");
nicePay.settXid("NORMALTEST02202211301010513135");
nicePay.setBankCd("CENA");
nicePay.setPrefix("7015102");
nicePay.setAmt("10000");
nicePay.setReferenceNo("OrdNo202210102323223");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getCustomerID());

//Request Reversal//
nicePay.reversal();

//Response Reversal//
String resultCd = nicePay.get("resultCd");
String resultMsg = nicePay.get("resultMsg");
String billingNm = nicePay.get("billingNm");
String goodsNm = nicePay.get("goodsNm");
String referenceNo = nicePay.get("referenceNo");
String amt = nicePay.get("amt");
```
:::



# See also

::::VerticalSplit
:::VerticalSplitItem
Visit the [Status Inquiry - API Checkout](docId\:RhH7PmISd6IHN99yWVJHm) page to find out API to check status inquiry specific for Checkout.
:::

:::VerticalSplitItem
Visit the [Cancel - API Checkout](docId\:CmiiEW1Oy21QP7qDEcUl-) page to find out API to cancel transaction specific for Checkout .
:::
::::

::::VerticalSplit
:::VerticalSplitItem
Visit the [Status Inquiry - API Virtual Account](docId\:hQ-6VN1CCHZdrYlM7ZWSQ) page to find out the API Virtual Account to check status inquiry on API specific for Payment.
:::

:::VerticalSplitItem
Visit the [Cancel - API Virtual Account](docId\:fRRDZ06DoDDqfeIZlWklq) page to find out API Virtual Account to cancel the transaction on API specific for Payment.
:::
::::