Payment - API NICEPAY Inquiry Virtual Account SNAP

8min

About 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.
﻿
Payment - 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/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.
﻿
Request Payment Header Parameter
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
﻿
Authorization
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.
﻿
Request Payment 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
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
﻿Bank Code - API SNAP﻿﻿
﻿
Response Payment Parameter
Parameter
Type
Length
Mandatory
Description
responseCode
String
﻿
Mandatory
﻿General Response Code and Message - API SNAP﻿﻿
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
﻿
Sample Parameter
Sample Request
Sample Response
{
  "responseCode": "2002500",
  "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": "ref100000001"
  },
  "additionalInfo": {
    "goodsNm": "Test Item",
  }
}
{
  "responseCode": "2002500",
  "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": "ref100000001"
  },
  "additionalInfo": {
    "goodsNm": "Test Item",
  }
}
﻿
﻿

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

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

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	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
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

Updated 11 Sep 2024

Did this page help you?

Inquiry - API NICEPAY Inquiry Virtual Account SNAP

Reversal - API NICEPAY Inquiry Virtual Account SNAP

Payment - API NICEPAY Inquiry Virtual Account SNAP

About Payment - API NICEPAY Inquiry Virtual Account SNAP

Payment - API NICEPAY Inquiry Virtual Account SNAP

Request Payment Header Parameter

Authorization

Request Payment Body Parameter

Response Payment Parameter

Sample Parameter

Welcome to NICEPAY DOCS