Payment - 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 so NICEPAY can inquiry the Customer data from the Merchant side.
Please request the access token firsthand before doing the authentication through the Request Access Token API - SNAP section.
API Endpoint | [merchant-domain]/api/v1.0/transfer-va/payment |
HTTP Method | HTTP POST |
Description | To proceed NIVA payment transaction |
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 | Mandatory | Description |
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 | Request Message Signature (EIFYcRuFfFh8nkVhLZrkGKYfk36SDM8VvV3EW/OoKbkCspqMCiU/9ZhCiO29EjUEF0j7vjkQpSidvtIpt/BkLg ==) |
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 | Channel Identification with name of client |
NICEPAY will request generate access_token to the Merchant through API. access_token that will be given follows the format from Merchant along with the expiry time is 15 minutes.
Parameter | Type | Length | Mandatory | Description |
partnerServiceId | String | 20 | Mandatory | Partner Service ID / Prefix |
customerNo | String | 40 | Mandatory | Customer Number |
virtualAccountNo | String | 25 | Mandatory | Virtual Account Number |
virtualAccountName | String | 100 | Optional | Virtual Account Name |
trxId | String | 40 | Mandatory | Merchant Order Number |
paymentRequestId | String | 128 | Mandatory | Unique Identifier |
paidAmount | Object | | Optional | Total Amount "paidAmount": {...} |
value | String | 12 | Mandatory | Value |
currency | String | 3 | Mandatory | Currency |
trxDateTime | String | 25 | Optional | Date Transaction |
additionalInfo | Object | | Optional | Additional Information "additionalInfo": {...} |
bankCd | String | 4 | Mandatory |
Parameter | Type | Length | Mandatory | Description |
responseCode | String | | Mandatory | |
responseMessage | String | | Mandatory | Response Message |
virtualAccountData | Object | | Mandatory | |
partnerServiceId | String | 20 | Mandatory | Partner Service ID / Prefix |
customerNo | String | 40 | Mandatory | Customer Number |
virtualAccountNo | String | 25 | Mandatory | Virtual Account Number |
virtualAccountName | String | 100 | Mandatory | Virtual Account Name |
trxId | String | 40 | Mandatory | Reference Number from Merchant |
paymentRequestId | String | 128 | Mandatory | Unique Identifier |
paidAmount | Object | | Optional | Total Amount "paidAmount": {...} |
value | String | 12 | Mandatory | Transaction Amount |
currency | String | 3 | Mandatory | Currency |
trxDateTime | String | 25 | Optional | Date Transaction |
additionalInfo | Object | | Optional | Additional Information "additionalInfo": {...} |
goodsNm | String | 200 | Mandatory | Goods Name |