Inquiry - 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, which allows Merchants to store Customer's data and generate their own Virtual Account numbers within their system, as long as they follow the provisions for creating NICEPAY's Virtual Account number.
Please request the access token firsthand before doing the authentication through the Request Access Token - API NICEPAY Inquiry Virtual Account SNAP section.
Service Code | 24 |
|---|---|
API Endpoint | [merchant-domain]/api/v1.0/transfer-va/inquiry |
Method | HTTP POST |
Description | To proceed the NIVA transaction status |
Content-type | application/json |
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.
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. | |
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 |
Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
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 |
Parameter | Type | Length | Required | Description |
|---|---|---|---|---|
responseCode | String | | Mandatory | |
responseMessage | String | | Mandatory | Response Message |
virtualAccountData | Object | | Mandatory | "virtualAccountData": { "partnerServiceId": "", "customerNo": "", "virtualAccountNo": "", "virtualAccountName": "John Test", "inquiryRequestId": "", "totalAmount": { ... }, "additionalInfo": { ... } } |
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 |
