Payment - 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) yang memberikan kebebasan untuk Merchant menyimpan data pelanggan dan membuat nomor Virtual Account sendiri di sistemnya selama masih mengikuti ketentuan pembuatan nomor VA dari NICEPAY.
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/payment |
|---|---|
HTTP Method | HTTP POST |
Description | Untuk melakukan pembayaran transaksi NIVA |
Content-type | application/json |
Pada saat melakukan proses integrasi, NICEPAY akan mengirimkan Public Key kepada Merchant. Kemudian, Merchant wajib memberi informasi terkait endpoint API Inquiry VA dan mengirimkan Client ID & Client Secret sesuai dengan spesifikasi NICEPAY kepada tim NICEPAY.
Hal tersebut perlu dilakukan agar NICEPAY dapat mengajukan akses token dan melakukan inquiry data Pelanggan yang berada di sisi Merchant. Sehingga, proses pembayaran dapat dijalankan dengan lancar oleh Pelanggan Anda.
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 | Signature will be generated by Merchant. | |
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 |
NICEPAY akan mengajukan generate access_token kepada Merchant melalui API. access_token yang diberikan akan mengikuti format dari Merchant dan memiliki waktu kedaluwarsa 15 menit.
Parameter | Tipe | Ukuran | Kebutuhan | Deskripsi |
|---|---|---|---|---|
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 | | Mandatory | Total Amount "paidAmount": {...} |
value | String | 12 | Mandatory | Value |
currency | String | 3 | Mandatory | Currency |
trxDateTime | String | 25 | Optional | Date Transaction |
additionalInfo | Object | | Mandatory | Additional Information "additionalInfo": {...} |
bankCd | String | 4 | Mandatory |
Parameter | Tipe | Ukuran | Kebutuhan | Deskripsi |
|---|---|---|---|---|
responseCode | String | | Mandatory | |
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 | | Mandatory | 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 |