---
title: Reversal - API NICEPAY Inquiry Virtual Account SNAP
slug: en/nicepay-api-snap-reversal-nicepay-inquiry-virtual-account
description: Information about Reversal - API NICEPAY Virtual Account SNAP available on the NICEPAY system
image: https://archbee-image-uploads.s3.amazonaws.com/ZHvSjR5ZrsoxwKbJa3xmo/UQzeZ1TY05QVqJygfyWhV_microsoftteams-image.png
icon: {"faIcon":"fa-solid fa-book"}
docTags:
createdAt: 2023-08-09T11:09:44.481Z
---
# About Reversal - API NICEPAY Inquiry Virtual Account SNAP
***
This API with SNAP standards contains information uses on the Virtual Account payment method with the NICEPAY Inquiry Virtual Account (NIVA) feature to send the notification from the Bank to NICEPAY. Then, NICEPAY will send a notification to the Merchant about the refund/cancellation of the paid transaction.
This issue rarely occurs and causes by specific conditions from the Bank, so the successful payment becomes canceled or refunded to the customer. If receiving the reversal notification, the Merchant recommended aborting the transaction, contacting The Customer, or proceeding with another action relevant to the Merchant procedure.
# Reversal API - API NICEPAY Inquiry Virtual Account SNAP
***
:::hint{type="warning"}
Please request the access token firsthand before doing the authentication through the [Request Access Token - API NICEPAY Inquiry Virtual Account SNAP](docId\:lIhdVAOBQwTamwijJ4k6E) section.
:::
| **API Endpoint** | `[merchant-domain]/api/v1.0/transfer-va/reversal` |
| ---------------- | ------------------------------------------------- |
| **Method** | `HTTP` `POST` |
| **Description** | For sending reversal notification to the Merchant |
| **Content-type** | `application/json` |
:::hint{type="info"}
When proceeding with the integration process, NICEPAY will send a Public Key to the Merchant. Then, the Merchant must inform the information related to the API VA Inquiry endpoint and send the Client ID & Client Secret based on NICEPAY specification to the NICEPAY team.
That must proceed so NICEPAY can request an access token and proceed with the Customer data inquiry on the Merchant side. Therefore, the payment process can easily proceed by the Customers.
:::
## Request Reversal Header Parameter
| **Parameter** | **Type** | **Length** | **Required** | **Description** | **Example** |
| --------------- | -------- | ---------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| `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 Reversal Body Parameter
| **Parameter** | **Type** | **Length** | **Required** | **Description** |
| -------------------- | -------- | ---------- | ------------ | ------------------------------------------------------------------------------- |
| `partnerServiceId` | String | 20 | Mandatory | Partner Service
ID / Prefix |
| `customerNo` | String | 40 | Mandatory | Customer Number |
| `virtualAccountNo` | String | 16 | Mandatory | Virtual Account Number. (If you have concern for VA number please call our PIC) |
| `virtualAccountName` | String | 100 | Optional | Virtual Account Name |
| `trxId` | String | 40 | Mandatory | Merchant Order Number |
| `paymentRequestId` | String | 128 | Mandatory | Unique Identifier
from Nicepay |
| `trxDateTime` | String | 25 | Optional | Transaction Date
Time |
| `paidAmount` | Object | | Mandatory | |
| `value` | String | 12 | Mandatory | Value |
| `currency` | String | 3 | Mandatory | Currency |
| `additionalInfo` | Object | | Mandatory | Additional Info
`"additionalInfo": {
`
` ...
`
` }` |
| `bankCd` | String | 4 | Mandatory | [Bank Code - API SNAP](docId:5PxU_cbDXVy2bIIli8_cv) |
## Response Reversal Parameter
| **Parameter** | **Type** | **Size** | **Rq** | **Description** |
| -------------------- | -------- | -------- | --------- | ------------------------------------------------------------------------------- |
| `responseCode` | String | | Mandatory | [General Response Code and Message - API SNAP](docId\:bJr4kjAmZCKnlN-5zRnvW) |
| `responseMessage` | String | | Mandatory | Response Message |
| `virtualAccountData` | Object | | Mandatory | `"virtualAccountData": {
`
`...}` |
| `partnerServiceId` | String | 20 | Mandatory | Partner Service ID / Prefix |
| `customerNo` | String | 40 | Mandatory | Customer Number |
| `virtualAccountNo` | String | 16 | Mandatory | Virtual Account Number. (If you have concern for VA number please call our PIC) |
| `virtualAccountName` | String | 100 | Mandatory | Virtual Account Name |
| `trxId` | String | 40 | Mandatory | Reference Number from Merchant |
| `paymentRequestId` | String | 128 | Mandatory | Unique Identifier from Nicepay |
| `trxDateTime` | String | 25 | Optional | Transaction Date Time |
| `paidAmount` | Object | | Mandatory | |
| `value` | String | 12 | Mandatory | Value |
| `currency` | String | 3 | Mandatory | Currency |
| `additionalInfo` | Object | | Mandatory | `"additionalInfo": {
`
` ...
`
` }` |
| `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: tXid202402111402271707638115
CHANNEL-ID: FIXOPEN001
{
"partnerServiceId": "70151021",
"customerNo": "10000001",
"virtualAccountNo": "7015102110000001",
"virtualAccountName": "John Test",
"trxId": "abcdefgh1234",
"paymentRequestId": "FIXOPEN0010000000006",
"paidAmount": {
"value": "10000.00",
"currency": "IDR"
},
"trxDateTime": "2024-02-01T15:40:06+07:00",
"additionalInfo": {
"bankCd": "BMRI"
}
}
```
Sample Response
```json
{
"responseCode": "2000000",
"responseMessage": "Successful",
"virtualAccountData": {
"partnerServiceId": "70151021",
"customerNo": "10000001",
"virtualAccountNo": "7015102110000001",
"virtualAccountName": "John Test",
"paymentRequestId": "FIXOPEN0010000000006",
"paidAmount": {
"value": "100000.00",
"currency": "IDR"
},
"trxDateTime": "2024-02-01T15:40:06+07:00",
"trxId": "abcdefgh1234"
},
"additionalInfo": {
"goodsNm": "Test"
}
}
```
:::