Registration - API Virtual Account
Virtual Account adalah salah satu metode pembayaran yang ditawarkan di NICEPAY. Pelanggan memiliki lebih banyak pilihan pembayaran melalui ATM, SMS Banking, Internet Banking, maupun Mobile Banking dengan menggunakan metode ini. Terdapat real-time Notifikasi yang terkirim langsung secara otomatis pada Pelanggan sesaat setelah Pelanggan menyelesaikan pembayaran.
- Jika Anda ingin melihat penjelasan umum metode pembayaran Virtual Account, Anda dapat mengunjungi Panduan Bayar VA.
- Untuk pengaturan integrasi fitur Fix Open dan NICEPAY Inquiry Virtual Account, Anda dapat mengunjungi halaman Virtual Account - Advance API.
Seperti yang sudah jelaskan pada halaman Struktur Virtual Account, panjang dari nomor VA yang dapat dibuat berbeda-beda pada setiap Bank.
Panjang nomor VA dapat ditentukan sendiri sesuai dengan kebutuhan bisnis selama nomor VA tersebut tidak melebihi kapasitas panjang maksimum yang sudah termasuk dengan angka prefix Bank dan prefix NICEPAY. Berikut adalah tabel persyaratan panjang nomor VA untuk beberapa Bank.
Bank | NICEPAY + Bank Prefix Length | Max Total VA |
BCA | 8 | 23 |
BRI | 8 | 18 |
Mandiri | 8 | 19 |
Maybank | 8 | 16 |
BNI | 7 | 16 |
Permata & Syariah | 7 | 16 |
CIMB | 7 | 19 |
Danamon | 7 | 16 |
HANA | 7 | 16 |
BJB | 7 | 16 |
BNC | 11 | 19 |
DKI | 9 | 16 |
Catatan:
- NICEPAY+Bank Prefix Length merupakan persyaratan panjang angka untuk nomor prefix NICEPAY dan Bank.
Contoh Kasus:
Apabila Anda sebagai Merchant ingin melakukan integrasi dengan VA Bank Mandiri, maka Anda wajib untuk memberikan ruang sebesar 8 digit untuk prefix VA yang terdiri dari prefix Bank dan prefix NICEPAY.
Selanjutnya, angka setelah prefix akan terbagi menjadi 2 tipe sesuai dengan tipe VA yang ingin buat:
- Fixed VA: Anda dapat melakukan kustomisasi angka setelah angka prefix VA yang NICEPAY sebut sebagai customer id atau merFixAcctId dengan catatan bahwa angka tersebut tidak lebih dari 19 digit panjang maksimal untuk nomor VA dari Bank Mandiri.
- Normal VA: Anda tidak dapat melakukan kustomisasi angka setelah angka prefix VA karena angka tersebut akan melalui proses generate secara otomatis dan acak oleh sistem dengan catatan bahwa angka tersebut tidak lebih dari 19 digit panjang maksimal untuk nomor VA dari Bank Mandiri.
Panjang nomor VA secara default adalah 16 digit. Kecuali ada skema khusus dari Bank, NICEPAY, dan Merchant. Meskipun setiap Bank dapat memiliki panjang nomor VA yang berbeda, Merchant disarankan untuk dapat mengakomodasi panjang nomor VA dalam satu deret maksimum 30 digit.
Registrasi Virtual Account bertujuan supaya Merchant dapat terhubung dengan sistem API pembayaran Virtual Account dengan sistem dari NICEPAY. Sehingga sistem pembayaran yang sudah disediakan dan di-host dari sisi Merchant dapat terintegrasi dengan sistem dari NICEPAY.
API Endpoint | /nicepay/direct/v2/registration |
Request Method | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
Request Format | application/json |
Berikut ini adalah daftar parameter untuk melakukan request registrasi metode pembayaran 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 |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20221214151286 |
iMid Required | AN | 10 | Merchant ID | NORMALTEST |
payMethod Required | N | 2 | 02 | |
currency Required | A | 3 | Currency | IDR |
amt Required | N | 12 | Amount | 10000 |
referenceNo Required | ANS | 40 | Merchant's Ref. No. | ordNo20221214151286 |
goodsNm Required | AN | 100 | Goods Name | Goods For Testing Virtual Account |
billingNm Required | A | 100 | Buyer Name | John Doe |
billingPhone Required | N | 15 | Buyer Phone No. | 081288998899 |
billingEmail Required | ANS | 40 | Buyer E-mail | |
billingAddr Required | AN | 100 | Buyer Address | Jln. Raya Kasablanka Kav.88 |
billingCity Required | A | 50 | Buyer City | South Jakarta |
billingState Required | A | 50 | Billing State | DKI Jakarta |
billingPostCd Required | N | 10 | Billing Post Number | 12800 |
billingCountry Required | A | 10 | Billing Country | Indonesia |
cartData | JSONstring | 4000 | Cart Data | |
bankCd Required for VA | A | 4 | CENA | |
vacctValidDt Required | N | 8 | VA Expiry Date (YYYYMMDD) | 20221231 |
vacctValidTm Required | N | 6 | VA Expiry Time (HH24MISS) | 235959 |
merFixAcctId Required | AN | 40 | Merchant Reserved VA ID | - |
userIP Required for CC, E-Wallet, Payloan,QRIS | AN | 15 | User IP | 127.0.0.1 |
dbProcessUrl Required | ANS | 255 | Notification URL | https://ptsv2.com/t/merchant/post/ |
merchantToken Required | AN | 255 | Merchant Token | c94d31f554faea1c5f28617dd0a9de70fcb4dc8de55a343bb887d032d95dd60a |
deliveryNm | A | 30 | Delivery Name | |
deliveryPhone | N | 15 | Delivery Phone | 081288998899 |
deliveryAddr | AN | 100 | Delivery Address | Jln. Raya Kasablanka Kav.88 |
deliveryCity | A | 50 | Delivery City | South Jakarta |
deliveryState | A | 50 | Delivery State | DKI Jakarta |
deliveryPostCd | N | 10 | Delivery Post Code | 12800 |
deliveryCountry | A | 10 | Delivery Country | Indonesia |
description | AN | 100 | Transaction Description | Testing Registration Virtual Account |
reqDomain | ANS | 100 | Request Domain | merchant.com |
reqServerIP | ANS | 15 | Request Server IP | 127.0.0.1 |
userSessionID | AN | 100 | User Session ID | 697D6922C961070967D3BA1BA5699C2C |
userAgent | ANS | 100 | User Agent | Mozilla |
userLanguage | A | 2 | User Language | en-US |
Silakan kunjungi bagian Virtual Account (VA) untuk mempelajari informasi umum mengenai metode pembayaran Virtual Account. Parameter di bawah berisi informasi tambahan mengenai informasi Registrasi Virtual Account.
Berikut adalah response parameter dari hasil request parameter untuk mendaftarkan metode pembayaran Virtual Account.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
resultCd | N | 14 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | NORMALTEST02202212141509411648 |
referenceNo | ANS | 40 | Merchant Ref. No. | ordNo20221214151286 |
payMethod | N | 2 | 02 | |
amt | N | 12 | Payment Amount | 1000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221214 |
transTm | N | 6 | Transaction Time (HH24MISS) | 150941 |
description | AN | 100 | Description | Testing Registration Virtual Account |
bankCd | AN | 4 | CENA | |
vacctNo | N | 20 | VA Number | 9912304000001486 |
mitraCd | AN | 4 | null | |
payNo | N | 12 | Payment Number | null |
currency | AN | 3 | Currency | IDR |
goodsNm | AN | 100 | Goods Name | Goods For Testing Virtual Account |
billingNm | A | 100 | Buyer Name | John Doe |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) | 20221231 |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) | 235959 |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) | null |
payValidTm | N | 6 | Expiry Time (HH24MISS) | null |
requestURL | ANS | 360 | Request URL | null |
paymentExpDt | N | 8 | QR Payment Expiry Date (YYYYMMDD) | null |
paymentExpTm | N | 6 | QR Payment Expiry Time (HH24MISS) | null |
qrContent | ANS | 360 | QR String in Plain Text | null |
qrUrl | ANS | 360 | URL for QR Image, Valid for 5 minutes | null |
Setelah Anda mendapatkan nomor VA untuk pelanggan Anda dari parameter vacctNo di response tersebut, Anda pun dapat langsung memberikan nomor VA nya kepada pelanggan Anda untuk di bayarkan.