Inquiry - API NICEPAY Inquiry Virtual Account SNAP

7min

About  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 to check the transaction status.
﻿
Inquiry - API NICEPAY Inquiry Virtual Account SNAP
﻿
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/inquiry
Method
HTTP POST
Description
To proceed the transaction status NIVA
Content-type
application/json
﻿
Request Inquiry Header Parameter
Parameter
Type
Length
Mandatory
Description or 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
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 id
﻿
Request Inquiry Body Parameter
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
inquiryRequestId
String
40
Mandatory
Unique Identifier for this Inquiry
additionalInfo
Object
﻿
Mandatory
"additionalInfo": {
            ...
        }
bankCd
String
4
Mandatory
﻿Bank Code - API SNAP﻿﻿
﻿
Response Inquiry Parameter
Parameter
Type
Length
Mandatory
Description
responseCode
String
﻿
Mandatory
﻿General Response Code and Message - API SNAP﻿﻿
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
﻿
Sample Parameter
Sample Request
Sample Response
{
	"responseCode": "2002400",
	"responseMessage": "Success",
	"virtualAccountData": {
		"partnerServiceId": "70151021",
		"customerNo": "89101110",
		"virtualAccountNo": "7015102189101110",
		"virtualAccountName": "John Test",
		"inquiryRequestId": "41807553358950093184",
		"totalAmount": {
			"value": "10000.00",
			"currency":"IDR"
		},
		"additionalInfo":{
		  	"trxId": "ref100000001"
		    "goodsNm": "Test Item"
		}
	}
}
{
	"responseCode": "2002400",
	"responseMessage": "Success",
	"virtualAccountData": {
		"partnerServiceId": "70151021",
		"customerNo": "89101110",
		"virtualAccountNo": "7015102189101110",
		"virtualAccountName": "John Test",
		"inquiryRequestId": "41807553358950093184",
		"totalAmount": {
			"value": "10000.00",
			"currency":"IDR"
		},
		"additionalInfo":{
		  	"trxId": "ref100000001"
		    "goodsNm": "Test Item"
		}
	}
}
﻿
﻿

API Endpoint	[merchant-domain]/api/v1.0/transfer-va/inquiry
Method	HTTP POST
Description	To proceed the transaction status NIVA
Content-type	application/json

Parameter	Type	Length	Mandatory	Description or 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	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 id

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
inquiryRequestId	String	40	Mandatory	Unique Identifier for this Inquiry
additionalInfo	Object		Mandatory	"additionalInfo": { ... }
bankCd	String	4	Mandatory	Bank Code - API SNAP

Parameter	Type	Length	Mandatory	Description
responseCode	String		Mandatory	General Response Code and Message - API SNAP
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

Updated 11 Sep 2024

Did this page help you?

API NICEPAY Inquiry Virtual Account SNAP

Payment - API NICEPAY Inquiry Virtual Account SNAP

Inquiry - API NICEPAY Inquiry Virtual Account SNAP

About Inquiry - API NICEPAY Inquiry Virtual Account SNAP

Inquiry - API NICEPAY Inquiry Virtual Account SNAP

Request Inquiry Header Parameter

Request Inquiry Body Parameter

Response Inquiry Parameter

Sample Parameter

Welcome to NICEPAY DOCS