Reversal - API NICEPAY Inquiry Virtual Account SNAP

8 min

About Reversal - 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 send the notification from the Bank to NICEPAY. Then, NICEPAY will send a notification to the Merchant about the refund/cancellation of the paid transaction.

This issue rarely occurs and causes by specific conditions from the Bank, so the successful payment becomes canceled or refunded to the customer. If receiving the reversal notification, the Merchant recommended aborting the transaction, contacting The Customer, or proceeding with another action relevant to the Merchant procedure.

Reversal API - API NICEPAY Inquiry Virtual Account SNAP

Please request the access token firsthand before doing the authentication through the Request Access Token - API NICEPAY Inquiry Virtual Account SNAP section.

API Endpoint	[merchant-domain]/api/v1.0/transfer-va/reversal
Method	HTTP POST
Description	For sending reversal notification to the Merchant
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 Reversal Header Parameter

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. Panduan X-Signature - Symmetric
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

Request Reversal Body Parameter

Parameter	Type	Length	Required	Description
partnerServiceId	String	20	Mandatory	Partner Service ID / Prefix
customerNo	String	40	Mandatory	Customer Number
virtualAccountNo	String	16	Mandatory	Virtual Account Number. (If you have concern for VA number please call our PIC)
virtualAccountName	String	100	Optional	Virtual Account Name
trxId	String	40	Mandatory	Merchant Order Number
paymentRequestId	String	128	Mandatory	Unique Identifier from Nicepay
trxDateTime	String	25	Optional	Transaction Date Time
paidAmount	Object		Mandatory
value	String	12	Mandatory	Value
currency	String	3	Mandatory	Currency
additionalInfo	Object		Mandatory	Additional Info "additionalInfo": { ... }
bankCd	String	4	Mandatory	Bank Code - API SNAP

Response Reversal Parameter

Parameter	Type	Size	Rq	Description
responseCode	String		Mandatory	General Response Code and Message - API SNAP
responseMessage	String		Mandatory	Response Message
virtualAccountData	Object		Mandatory	"virtualAccountData": { ...}
partnerServiceId	String	20	Mandatory	Partner Service ID / Prefix
customerNo	String	40	Mandatory	Customer Number
virtualAccountNo	String	16	Mandatory	Virtual Account Number. (If you have concern for VA number please call our PIC)
virtualAccountName	String	100	Mandatory	Virtual Account Name
trxId	String	40	Mandatory	Reference Number from Merchant
paymentRequestId	String	128	Mandatory	Unique Identifier from Nicepay
trxDateTime	String	25	Optional	Transaction Date Time
paidAmount	Object		Mandatory
value	String	12	Mandatory	Value
currency	String	3	Mandatory	Currency
additionalInfo	Object		Mandatory	"additionalInfo": { ... }
goodsNm	String	200	Mandatory	Goods Name

Sample Parameter

{
  "responseCode": "2000000",
  "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": "abcdefgh1234"
  },
  "additionalInfo": {
    "goodsNm": "Test"
  }
}