Registration - API Checkout
Langkah pada Registration - API Checkout ini berfungsi untuk mendaftarkan sebuah request checkout belanja dari Pelanggan Anda kepada kami. Sehingga Pelanggan Anda dapat membayar jumlah transaksi yang ditagihkan pada payment page yang NICEPAY sediakan.
Pada prinsipnya, semua metode pembayaran pada Checkout API memiliki proses yang sama. Hanya saja yang membedakan adalah parameter pada setiap metode pembayaran.
Pada saat Pelanggan melakukan proses Checkout, sistem melakukan proses pendaftaran pesanan sebelum Pelanggan dapat melakukan proses pembayaran pada metode pembayaran yang diinginkan melalui tautan pembayaran yang didapatkan.
Silakan kunjungi halaman Payment - API Checkout untuk mengetahui penjelasan lebih rinci terkait API khusus pembayaran.
Berikut ini adalah metode pembayaran yang dapat dipilih oleh Pelanggan untuk melakukan proses pembayaran, yakni:
Silakan melanjutkan membaca halaman ini untuk mengetahui rincian API Registration lebih lanjut.
Untuk dapat menggunakan seluruh metode pembayaran pada API Checkout kecuali QRIS, Anda diperlukan untuk mendaftarkan transaksi tersebut dengan API Registrasi Checkout ini. Berikut parameternya:
API URL | /nicepay/redirect/v2/registration |
Method | POST |
Header | Content-Type: application/json |
Merchant Token | SHA256 (timestamp+ iMid+ referenceNo+ amt+ merchantKey) |
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20230516660517 |
payMethod Required | N | 2 | 00 | |
bankCd | A | 4 | Bank Code | CENA |
currency Required | AN | 3 | Currency | IDR |
amt | N | 12 | Transaction Amount | 10000 |
referenceNo Required | ANS | 40 | Merchant Order Number | MerchantReferenceNumber001 |
merchantToken Required | AN | 255 | Merchant Token | 4686062c297a3e48cf385953f411bbd48753bb70b041f2113a3e7c2e99c54f3c |
callBackUrl | AN | 255 | Payment Result Forward URL | https://www.merchant.com/callbackUrl/ |
dbProcessUrl | AN | 255 | Payment Notification URL | https://www.merchant.com/dbProcessUrl |
goodsNm Required | AN | 100 | Goods Name | Merchant Goods 1 |
mitraCd Required For CVS, E-Wallet & Payloan | AN | 4 | Mitra Code | DANA |
vacctValidDt Required For VA | N | 8 | VA Expiry Date (YYYYMMDD) | 20230531 |
vacctValidTm Required For VA | N | 8 | VA Expiry Time (HH24MISS) | 235959 |
description Required | AN | 100 | Transaction Description | This Is The Description Of The Payment |
billingNm Required | A | 100 | Billing Name | John Doe |
billingPhone Required | N | 15 | Billing Phone | 08123456789 |
billingEmail Required | AN | 40 | Billing E-mail | |
billingAddr | AN | 100 | Billing Address | Jln. Raya Casablanka Kav.88 |
billingCity Required | A | 50 | Billing City | South Jakarta |
billingState Required | A | 50 | Billing State | DKI Jakarta |
billingPostCd Required | N | 10 | Billing Post Number | 10200 |
billingCountry Required | A | 10 | Billing Country | Indonesia |
userIP | AN | 15 | User IP | 127.0.0.1 |
cartData Required | AN | 4000 | Cart Data | {\"count\":\"1\",\"item\":[{\"goods_id\":\"BB12345678\",\"goods_detail\":\"BB123456\",\"goods_name\":\"iPhone5S\",\"goods_amt\":\"10000\",\"goods_type\":\"Smartphone\",\"goods_url\":\"http://merchant.com/cellphones/iphone5s_64g\",\"goods_quantity\":\"1\",\"goods_sellers_id\":\"SEL123\",\"goods_sellers_name\":\"Sellers1\"}]} |
deliveryNm | A | 30 | Delivery Name | Merchant's Name |
deliveryPhone | N | 15 | Delivery Phone | 08123456789 |
deliveryAddr | AN | 100 | Delivery Address | Jln. Dr.Saharjo No.88 |
deliveryCity | A | 50 | Delivery City | South Jakarta |
deliveryState | A | 50 | Delivery State | DKI Jakarta |
deliveryPostCd | N | 10 | Delivery Post Number | 10201 |
deliveryCountry | A | 10 | Delivery Country | Indonesia |
vat | N | 12 | Value Added Tax (VAT) | (empty) |
fee | N | 12 | Service Fee | (empty) |
notaxAmt | N | 12 | Tax Free Amount | (empty) |
reqDt | N | 8 | Request Date (YYYYMMDD) | (empty) |
reqTm | N | 6 | Request Time (HH24MISS) | (empty) |
reqDomain | AN | 100 | Request Domain | (empty) |
reqServerIP | AN | 15 | Request Server IP | (empty) |
reqClientVer | AN | 50 | Request Client Version | (empty) |
userSessionID | AN | 100 | User Session ID | (empty) |
userAgent | AN | 100 | User Agent Information | (empty) |
userLanguage | A | 2 | User Language | (empty) |
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | SUCCESS | |
tXid | AN | 30 | Transaction ID | IONPAYTEST00202305161555223616 When Success |
referenceNo | ANS | 40 | Merchant Order Number | MerchantReferenceNumber001 |
payMethod | N | 2 | 00 When Success | |
amt | N | 12 | Amount | 10000 When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20230516 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 135959 When Success |
description | AN | 100 | Transaction Description | This Is The Description Of The Payment When Success |
currency | AN | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Merchant Goods 1 When Success |
billingNm | A | 100 | Buyer Name | John Doe When Success |
payValidDt | N | 8 | CVS Expiry Date (YYYYMMDD) | null |
payValidTm | N | 6 | CVS Expiry Time (HH24MISS) | null |
paymentURL | AN | 40 | Redirect URL NICEPAY | https://www.nicepay.co.id/nicepay/redirect/v2/payment |
Setelah transaksi Anda sudah didaftarkan, arahkan pelanggan Anda langsung menuju halaman Payment kami untuk melakukan proses pembayaran. Silakan periksa halaman Payment - API Checkout untuk mengetahui penjelasan lebih rinci.
Cart Data pada Checkout API berguna untuk mendeklarasikan item apa saja yang akan di-checkout beserta rincian dan harga per item. Cart Data ini berlaku untuk semua metode pembayaran, kecuali metode pembayaran menggunakan Payloan dikarenakan metode pembayaran Payloan memiliki Cart Data khusus.
- cartData harus dilepas dalam bentuk string.
- Karakter spesial tidak didukung dalam cartData.
- Pastikan bahwa count sama dengan jumlah object item.
- Pastikan bahwa goods_amt x goods_quantity sama dengan parameter amt.
Parameter | Deskripsi | Contoh |
Count | Total jumlah dari keseluruhan cart data | 2 |
Item | Terbagi menjadi 5 macam parameter, yaitu img_url, goods_name, goods_detail, goods_amt, dan goods_quantity | - |
Penjelasan detail pada parameter Item.
Parameter | Deskripsi | Contoh |
img_url | URL Gambar Barang (Ukuran 50px x 50px) | http://img.aaa.com/ima1.jpg |
goods_name | Nama Barang | Item 1 Name |
goods_detail | Deskripsi Detail Barang | Item 1 Detail |
goods_amt | Harga Barang | 700 |
goods_quantity | Jumlah Barang | 1 |
Parameter | Deskripsi |
count | Total cart data count |
item | List of goods |
item -> goods_id | Goods ID |
item -> goods_detail | Goods Detail |
item -> goods_name | Goods Name |
item -> goods_amt | Goods Amount |
item -> goods_type | Goods Type |
item -> goods_url | Goods URL |
item -> goods_quantity | Goods Quantity |
item -> goods_sellers_id | Seller's ID |
item -> goods_sellers_name | Seller's Name |
cartData wajib dilepas dalam format string.
- cartData secara spesifik untuk Payloan.
- Pastikan parameter-parameter countberdasarkan dengan nomor tipe barang-barang.
- Pastikan goods_sellers_id dan goods_sellers_name berisi sesuai dengan sellers pada Registration.
Parameter | Deskripsi |
sellersId | Seller's ID |
sellersNm | Seller's Name |
sellersEmail | Seller's E-mail |
sellersUrl | Seller's Url |
sellersAddress -> sellerNm | Seller's Name |
sellersAddress -> sellerLastNm | Seller's Last Name |
sellersAddress -> sellerAddr | Seller's Address |
sellersAddress -> sellerCity | Seller's City |
sellersAddress -> sellerPostCd | Seller's Postal Code |
sellersAddress -> sellerPhone | Seller's Phone |
sellersAddress -> sellerCountry | Seller's Country |