Virtual Account Static
About API Virtual Account Static (Fix Open)
In the Static Virtual Account payment method (fix open), the Customer can use the same Virtual Account number continuously for multiple payments. Static VA integration uses for the VA Fix Open payment method.
- To find out more about Virtual Account payment information, you can read on Virtual Account (VA).
- To learn a general explanation of Virtual Account payment method, you can visit VA Payment Guide page.
Merchant Registration
Credential | Description |
|---|---|
iMid | Merchant ID |
encodeKey | Merchant API Key |
To support setup needs, please download the following file from the NICEPAY library.
NICEPAY API Registration
NICEPAY API Registration aims to enable Merchants to register the API system for payment in the Merchant system and integrate it with the system from NICEPAY. This step is done first so the system knows that the related Merchant has been officially registered and can be connected to services from NICEPAY.
API URL | https://www.nicepay.co.id/nicepay/api/vacctCustomerRegist.do |
|---|---|
Request Method | POST |
Merchant Token | SHA256(iMid+customerId+merchantKey) |
Request Format | application/x-www-form-urlencoded |
Request Parameter for Registration VA Static
The following is a list of parameters for submitting the registration for a static-type (fix open) 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 to services from NICEPAY.
Parameter | Tipe | Size | Description | Example / Notes |
|---|---|---|---|---|
iMid Required | AN | 10 | Merchant ID | FIXOPEN001 |
customerId Required | N | Max 8 (Depend on Merchant Prefix) | Merchant Customer ID | 10021198 |
customerNm Required | AN | 20 - 30 | Customer Name | Jack |
merchantToken Required | AN | 255 | Merchant Token | c31fec3c0e66c9d8703f9f8221f7c450950d7d26822abe037ce33c12f462c785 |
Response Parameter for Registration VA Static
The following are the response parameters from the results of the request parameter to register the Virtual Account statistics payment method.
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
resultCd Required | N | 4 | Result Code: Result Code | 0000 |
resultMsg Required | AN | 255 | Result Message: Error Code | SUCCESS |
customerID Required | N | Max 8 (Depend on Merchant Prefix) | Merchant Customer ID | 10021198 |
customerNm | AN | 20 - 30 | Merchant Customer Name | Jack |
vacctInfoList Required | Array of object | | Bank Virtual Account List | [ { "bankCd": "BDIN", "vacctNo": "7917019110021198" },...] |
Sample JSON Registration Virtual Account Static
// VA Registration //
// VA Registration Mandatory Field
nicePay.setCustomerID("10021198");
nicePay.setCustomerName("Jack");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getCustomerID()));
// Request VA Registration
nicePay.vaRegist();
// Response String //
System.out.println("Final Response String : " + nicePay.getResponseString());
String resultCd = nicePay.Get("resultCd");
String resultMsg = nicePay.Get("resultMsg");
String customerId = nicePay.Get("customerId");
String vacctInfoList = nicePay.Get("VacctInfoList");Vacct Info List
Parameter | Type | Size | Description | Example/Notes |
|---|---|---|---|---|
bankCd Required | AN | 4 | BDIN | |
vacctNo Required | N | 16 | Virtual Account Number | 7917019110021198 |
Sample JSON Vacct Account
{
"vacctInfoList": [
{
"bankCd": "BDIN",
"vacctNo": "7917019110021198"
},
{
"bankCd": "BNIA",
"vacctNo": "11695109010021198"
},
{
"bankCd": "BMRI",
"vacctNo": "8804910910021198"
},
{
"bankCd": "BNIN",
"vacctNo": "1111111310021198"
},
{
"bankCd": "IBBK",
"vacctNo": "1111112010021198"
},
{
"bankCd": "HNBN",
"vacctNo": "765430000000000010021198"
},
{
"bankCd": "BBBA",
"vacctNo": "1111111910021198"
},
{
"bankCd": "CENA",
"vacctNo": "7007216110021198"
},
{
"bankCd": "YUDB",
"vacctNo": "9044444450010021198"
}
]
}
NICEPAY Virtual Account Inquiry
NICEPAY Virtual Account Inquiry aims to obtain Customer information and also Virtual Account numbers to proceed with monitoring for further development purposes.
The settings for NICEPAY Virtual Account Inquiry aim to collect information on a list of Virtual Accounts registered from any Bank based on merFixId .
Target Url | https://www.nicepay.co.id/nicepay/api/vacctCustomerInquiry.do |
|---|---|
Method | POST, GET |
Description | To perform VA checking on customerId |
Merchant Token | SHA256(iMid+customerId+merchantKey) |
Request Format | application/x-www-form-urlencoded |
Request Parameter for Virtual Account Inquiry
The following is a list of parameters for requesting a Virtual Account inquiry. This parameter is used through the API testing platform as one of the steps so that the Merchant's system can connect to the system from NICEPAY.
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
iMid Required | AN | 10 | Merchant ID | FIXOPEN001 |
customerId Required | N | Max 8 (Depend on Merchant Prefix) | Merchant Customer ID | 10021198 |
merchantToken Required | AN | 255 | Merchant Token | c31fec3c0e66c9d8703f9f8221f7c450950d7d26822abe037ce33c12f462c785 |
Response Parameter for Inquiry
The following is the response parameters from the results of the request parameter to register the Virtual Account Static payment method .
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
resultCd Required | N | 4 | Result Code: Result Code | 0000 |
resultMsg Required | AN | 255 | Result Message: Error Code | SUCCESS |
customerID Required | N | Max 8 (Depend on Merchant Prefix) | Merchant Customer ID | 10021198 |
customerNm Required | AN | 20 - 30 | Merchant Customer Name | Jack |
vacctInfoList Required | Array of object | | Bank Virtual Account List | [ { "bankCd": "BDIN", "vacctNo": "7917019110021198" }, { "bankCd": "BNIA", "vacctNo": "11695109010021198" }, ... ] |
Sample JSON NICEPAY Virtual Account Inquiry
{
"resultCd": "0000",
"resultMsg": "SUCCESS",
"customerId": "10021198",
"customerNm": "Jack",
"vacctInfoList": [
{
"bankCd": "BDIN",
"vacctNo": "7917019110021198"
},
{
"bankCd": "BNIA",
"vacctNo": "11695109010021198"
},
{
"bankCd": "BMRI",
"vacctNo": "8804910910021198"
},
{
"bankCd": "BNIN",
"vacctNo": "1111111310021198"
},
{
"bankCd": "IBBK",
"vacctNo": "1111112010021198"
},
{
"bankCd": "HNBN",
"vacctNo": "765430000000000010021198"
},
{
"bankCd": "BBBA",
"vacctNo": "1111111910021198"
},
{
"bankCd": "CENA",
"vacctNo": "7007216110021198"
},
{
"bankCd": "YUDB",
"vacctNo": "9044444450010021198"
}
]
}Vacct Info List
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
bankCd Required | AN | 4 | BDIN | |
vacctNo Required | N | 16 | Virtual Account Number | 7917019110021198 |
Sample JSON Vacct Account
{
"vacctInfoList": [
{
"bankCd": "BDIN",
"vacctNo": "7917019110021198"
},
{
"bankCd": "BNIA",
"vacctNo": "11695109010021198"
},
{
"bankCd": "BMRI",
"vacctNo": "8804910910021198"
},
{
"bankCd": "BNIN",
"vacctNo": "1111111310021198"
},
{
"bankCd": "IBBK",
"vacctNo": "1111112010021198"
},
{
"bankCd": "HNBN",
"vacctNo": "765430000000000010021198"
},
{
"bankCd": "BBBA",
"vacctNo": "1111111910021198"
},
{
"bankCd": "CENA",
"vacctNo": "7007216110021198"
},
{
"bankCd": "YUDB",
"vacctNo": "9044444450010021198"
}
]
}
NICEPAY Virtual Account Deposit
NICEPAY Virtual Account Deposit in the system aims to check the status of a fixed open Virtual Account and to display how much amt (amount) is paid with a certain tXid (transaction ID) and at a certain time.
Target Url | https://www.nicepay.co.id/nicepay/api/vacctInquiry.do |
|---|---|
Method | POST |
Description | API Check Status For VA Fixopen |
Merchant Token | SHA256(iMid+customerId+merchantKey) |
Request Format | application/x-www-form-urlencoded |
Request Parameter for Virtual Account Check Status
The following is a list of parameters for requesting a Virtual Account check deposit status. This parameter uses through the API testing platform as one of the steps so that the Merchant's system can connect to the system from NICEPAY.
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
iMid Required | AN | 10 | Merchant ID | FIXOPEN001 |
vacctNo Required | N | 16 | Virtual Account Number | 8804910910021197 |
merchantToken Required | AN | 255 | Merchant Token | 20221215 |
startDt Required | N | 8 | Request Start Date (YYYYMMDD) | 20221222 |
endDt Required | N | 8 | Request Start Date (YYYYMMDD) | 75d137e8823108e47d04dadc3290cb36dc305d573323123f410c6f61acf1db63 |
Response Parameter for Virtual Account Check Status
The following are the response parameters from the request parameter result for the Virtual Account check status.
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
resultCd Required | N | 4 | SUCCESS | |
resultMsg Required | AN | 255 | Result Message: Error Code | SUCCESS |
vacctNo Required | N | 16 | Virtual Account Number | 8804910910021197 |
depositInfo Required | Array of object | | Bank Virtual Account List | [ { "bankCd": "BMRI", "date": "20221220", "time": "100733", "amt": "1600000", "tXid": "FIXOPEN00102202212201007334066", "status": "0", "referenceNo": "10021197" },...] |
Sample JSON Virtual Account Deposit
// VA Check Status Deposit//
nicepay.setiMid("FIXOPEN001");
nicepay.setVacctNo("8804910910021197");
nicepay.setMerchantToken(nicepay.getToken());
nicepay.setStartDt("20221215");
nicepay.setEndDt("20221231");
// Request VA Check Status Deposit//
nicepay.vaCheckStatusDeposit();
// Response VA Check Status Deposit//
System.out.println("Response :" + nicepay.getResponse();
String resultCd = nicepay.get("resultCd");
String resultMsg = nicepay.get("resultMsg");
String vacctNo = nicepay.get("vacctNo");
String depositInfo = nicepay.get("depositInfo");
NICEPAY Virtual Account Update
NICEPAY Virtual Account Update on the system aims to update the Merchant's Virtual Account profile information. Merchants can make modifications to the Virtual Account to update or delete via updateType .
Target Url | https://www.nicepay.co.id/nicepay/api/vacctCustomerUpdate.do |
|---|---|
Method | POST |
Description | merficAcctNm API For Virtual Account Update |
Merchant Token | SHA256(iMid+customerId+merchantKey) |
Request format | application/x-www-form-urlencoded |
Request Parameter for Virtual Account Update
The following is a list of parameters for requesting updates from transactions made on static-type (fix open) Virtual Account payment methods. This parameter uses in the API testing platform as one of the stages so that the Merchant's system can connect to the services from NICEPAY.
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
iMid Required | AN | 10 | Merchant ID | FIXOPEN001 |
customerId Required | N | Max 8 (Depend on Merchant Prefix) | Customer ID | 10021197 |
merchantToken Required | AN | 255 | Merchant Token | c92a4372a8417d96407becec2c3221033358c16e1c29b5ccf7fe0cec211ecbf4 |
customerNm Required | AN | 20 - 30 | Customer Name | Howard |
updateType Required | N | 2 | 1: Create 2: Update 3: Delete | 2 |
Response Parameter for Virtual Account Update
The following is the response parameters from the results of the request parameters for the Virtual Account update.
Parameter | Type | Size | Description | Example / Notes |
|---|---|---|---|---|
resultCd Required | N | 4 | 0000 | |
resultMsg Required | AN | 255 | Result Message: Error Code | SUCCESS |
customerNm Required | A | 20 - 30 | Merchant Customer Name | Howard |
customerId Required | N | Max 8 (Depend on Merchant Prefix) | Merchant Customer ID | 10021197 |
vacctInfoList Required | Array of Object | | Bank Virtual Account List | [ { "bankCd": "BDIN", "vacctNo": "7917019110021197" },...] |
Sample Response VA Update
// VA Update///
nicepay.setiMid("FIXOPEN001");
nicepay.setCustomerId("10021197");
nicepay.setMerchantToken(nicepay.getToken());
nicepay.setCustomerNm("Howard");
nicepay.setUpdateType("2");
// Request VA Update//
nicepay.vaUpdate();
// Response VA Update//
System.out.println("Response :" + nicepay.getResponse();
String resultCd = nicepay.get("resultCd");
String resultMsg = nicepay.get("resultMsg");
String customerNm = nicepay.get("customerNm");
String customerId = nicepay.get("customerId");
String vacctInfoList = nicepay.get("depositInfo");
See Also
Visit the Status Inquiry - API Checkout page to find out API to check status inquiry specific for Checkout.
Visit the Cancel - API Checkout page to find out API to cancel transaction specific for Checkout.
Visit the Status Inquiry - API Virtual Account page to find out the API Virtual Account to check status inquiry on API specific for Payment.
Visit the Cancel - API Virtual Account page to find out API Virtual Account to cancel the transaction on API specific for Payment.