NICEPAY API
...
Advance API - SNAP
API NICEPAY Inquiry Virtual Ac...

Reversal - API NICEPAY Inquiry Virtual Account SNAP

7min

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



Request Reversal Header Parameter

Parameter

Tipe

Ukuran

Kebutuhan

Deskripsi / Contoh

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 Reversal Body Parameter

Parameter

Type

Length

Mandatory

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



Response Reversal Parameter

Parameter

Type

Size

Mandatory

Description

responseCode

String



Mandatory

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

Sample Request
Sample Response