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

Reversal - API NICEPAY Inquiry Virtual Account SNAP

7min

Tentang Reversal - API NICEPAY Inquiry Virtual Account SNAP



Bagian ini berisi tentang informasi terkait API dengan standar SNAP yang digunakan pada metode pembayaran Virtual Account dengan fitur NICEPAY Inquiry Virtual Account (NIVA) untuk mengirimkan notifikasi dari Bank kepada NICEPAY. Kemudian, NICEPAY akan mengirimkan notifikasi kepada Merchant terkait pengembalian dana/pembatalan terhadap pembayaran yang telah berhasil terbayar.

Hal ini sangat jarang terjadi dan disebabkan kondisi tertentu pada Bank, sehingga pembayaran yang telah berhasil menjadi batal atau dilakukan pengembalian dana kembali kepada Pelanggan. Ketika mendapatkan notifikasi reversal, Merchant disarankan untuk membatalkan transaksi, menghubungi Pelanggan atau tindakan lain sesuai prosedur pada sisi Merchant.



Reversal - API NICEPAY Inquiry Virtual Account SNAP



Silakan mengajukan akses token terlebih dahulu untuk melakukan autentikasi melalui bagian Request Access Token API - SNAP.

API Endpoint

[merchant-domain]/api/v1.0/transfer-va/reversal

Method

HTTP POST

Description

Untuk mengirimkan notifikasi reversal kepada 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

Tipe

Ukuran

Kebutuhan

Deskripsi

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

Tipe

Ukuran

Kebutuhan

Deskripsi

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