NICEPAY Inquiry Virtual Account

23 min

Tentang API NICEPAY Inquiry Virtual Account

Integrasi NICEPAY Inquiry Virtual Account digunakan untuk metode pembayaran Virtual Account tipe NICEPAY Inquiry Virtual Account. Pada metode pembayaran ini, data Pelanggan berada di sisi Merchant. Sehingga, pada setiap pembayaran dari Bank, NICEPAY membutuhkan inquiry data Pelanggan, konfirmasi pembayaran, dan melakukan request pembayaran ke Merchant.

Alur NICEPAY Inquiry Virtual Account

Flow NICEPAY Inquiry Virtual Account

Inquiry Process NICEPAY to Merchant

Proses ini bertujuan untuk mengetahui rincian tagihan. Setelah NICEPAY mendapatkan permintaan inquiry dari Bank, NICEPAY akan menggunakan Merchant service untuk mendapatkan informasi rincian data Pelanggan. Kemudian, data tersebut akan tersimpan dalam riwayat internal sistem NICEPAY dan akan dikirim ke Bank menggunakan format response Bank inquiry.

API URL	https:// < merchant URL for inquiry >
Request Method	POST (Body Raw JSON)
Merchant Token	-
Request Format	-

Inquiry Request Parameter

Berikut ini adalah daftar parameter untuk melakukan proses Inquiry NICEPAY kepada Merchant dari transaksi yang dilakukan pada metode pembayaran Virtual Account tipe NICEPAY Inquiry Virtual Account. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari NICEPAY.

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
customerId	N	9	Customer ID	891011101
merchantToken	AN	255	SHA256 (Merchant ID + Customer ID + Merchant Key)	141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b
prefix	N	7	Virtual Account Prefix Number	7015102
bankCd	AN	4	Bank Code	CENA

Inquiry Response Parameter

Berikut adalah response parameter dari hasil request parameter untuk proses Inquiry NICEPAY kepada Merchant.

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
billingNm	N	100	Customer Name	John Doe
goodsNm	AN	100	Goods/Item Name	Testing Buying
referenceNo	N	40	Reference Number for Payment	ordNo20221130101148
amt	AN	12	Total Bill Amount	5000 Normal Amount Only
resultCd	N	4	Result Code of Inquiry Status	0000
resultMsg	AN	255	Result Message for the Result Code	SUCCESS

Sample JSON Inquiry Process NICEPAY to Merchant

{
    "resultCd" : "0000",
    "resultMsg" : "SUCCESS",
    "billingNm" : "John Doe",
    "goodsNm" : "Testing Buying",
    "referenceNo" : "ordNo20221130101148",
    "amt" : "5000"
}

Payment Process NICEPAY to Merchant

Payment Process NICEPAY to Merchant adalah tahap untuk melanjutkan proses pembayaran yang dilakukan Pelanggan. Saat Bank melakukan payment request ke NICEPAY menggunakan nomor Virtual Account, NICEPAY akan memanggil Merchant payment URL service untuk proses pembayaran. Merchant menentukan response payment untuk menerima atau menolak pembayaran dari Pelanggan.

API End Point	https:// < Merchant URL for payment >
Method	POST (Body Raw JSON)

Payment Request Parameter

Berikut ini adalah daftar parameter untuk melakukan Payment Process NICEPAY to Merchant dari transaksi yang dilakukan pada metode pembayaran Virtual Account tipe NICEPAY Inquiry Virtual Account. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari NICEPAY.

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
customerId	N	9	Customer ID	110000001
merchantToken	AN	255	SHA256 (Merchant ID + Customer ID + amt + Merchant Key)	141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b
referenceNo	AN	40	Reference Number from Inquiry	OrdNo202210102323223
prefix	N	7	Virtual Account Prefix Number	7015102
bankCd	AN	4	Bank Code	CENA
amt	N	12	Total Bill Amount	10000
tXid	AN	30	Transaction ID from NICEPAY	NORMALTEST02202211301010513135

Payment Response Parameter

Berikut adalah response parameter dari hasil request parameter untuk Payment Process NICEPAY to Merchant.

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
billingNm	N	100	Customer Name	John Doe
goodsNm	AN	255	Goods/Item Name	Testing Buying
referenceNo	N	7	Reference Number for Payment	ordNo2022113010114
amt	AN	4	Total Bill Amount	Normal amount only
resultCd		4	Result Code of Inquiry Status	0000
resultMsg	AN	255	Result Message for the Result Code	SUCCESS

Sample JSON Payment Process NICEPAY to Merchant

{
    "resultCd" : "0000",
    "resultMsg" : "SUCCESS",
    "billingNm" : "John Doe",
    "goodsNm" : "Testing Buying",
    "referenceNo" : "ordNo20221130101148",
    "amt" : "10000"
}

Reversal Process NICEPAY to Merchant

Reversal Process NICEPAY to Merchant adalah proses pengembalian dana yang terjadi akibat terjadi isu di dalam internal sistem Bank. Pada proses ini, NICEPAY akan melanjutkan informasi status yang didapat dari Bank kepada Merchant.

API End Point	https:// < Merchant URL for reversal >
Method	POST (Body Raw JSON)

Process Flow

Proses Reversal VA

Reversal Request Parameter

Berikut ini adalah daftar parameter untuk melakukan Reversal Process NICEPAY to Merchant dari transaksi yang dilakukan pada metode pembayaran Virtual Account tipe NICEPAY Inquiry Virtual Account. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari NICEPAY.

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
customerId	N	9	Customer ID	110000001
merchantToken	AN	255	SHA256 (Merchant ID + Customer ID + amt + Merchant Key)	141fd2368aa80ea0e600b1b4d7a42c1e731e74a27a03521e8e28150cc00bc05b
referenceNo	AN	40	Reference Number from Inquiry	OrdNo202210102323223
prefix	N	7	Virtual Account Prefix Number	7015102
bankCd	AN	4	Bank Code	CENA
amt	N	12	Total Bill Amount	10000
tXid	AN	30	Transaction ID from NICEPAY	NORMALTEST02202211301010513135

Reversal Response Parameter

Berikut adalah response parameter dari hasil request parameter untuk Reversal Process NICEPAY to Merchant.

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
billingNm	N	100	Customer Name	John Doe Top-Up Amount Only
goodsNm	AN	100	Goods/Item Name	Testing Reversal Transaction Top-Up Amount Only
referenceNo	N	40	Reference Number for Payment	OrdNo202210102323223
amt	AN	12	Total Bill Amount	50000
resultCd		34	Result Code of Inquiry Status Result Code	0000
resultMsg		255	Result Message for the Result Code	SUCCESS

Sample JSON Reversal Process NICEPAY to Merchant

{
    "resultCd" : "0000",
    "resultMsg" : "SUCCESS",
    "billingNm" : "John Doe",
    "referenceNo" : "OrdNo202210102323223",
    "goodsNm" : "Testing Reversal Transaction",
    "amt" : "50000"
}