Registration - API Payloan
API ini digunakan oleh Merchant untuk mendaftarkan transaksi kepada sistem NICEPAY agar dapat melakukan pendaftaran transaksi.
API Payloan Registration digunakan supaya Merchant dapat terhubung dengan sistem API pembayaran Payloan dari NICEPAY. Sehingga sistem pembayaran yang sudah disediakan dan di-host dari sisi Merchant dapat terintegrasi dengan sistem dari NICEPAY. API berikut dapat digunakan untuk registrasi Indodana, Akulaku, dan Kredivo.
API Endpoint | /nicepay/direct/v2/registration |
Request Method | POST |
Description | Performs Transaction Regist to NICEPAY |
Merchant Token | SHA256(timeStamp+iMid+tXid+amt+merchantKey) |
Request Format | application/json |
Berikut ini adalah daftar parameter untuk melakukan request registrasi metode pembayaran Payloan. 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) | 20220131125959 |
iMid Required | AN | 10 | Merchant ID | PAYLOANTES |
payMethod Required | N | 2 | 06 | |
currency Required | A | 3 | Currency | IDR |
amt Required | N | 12 | Amount | 10000 |
referenceNo Required | ANS | 40 | Merchant's Ref. No. | ORD12345 |
callBackUrl | ANS | 255 | Payment Result URL | |
goodsNm Required | AN | 100 | Goods Name | Test Transaction Nicepay |
billingNm Required | A | 100 | Buyer Name | John Doe |
billingPhone Required | N | 15 | Buyer Phone No. | 08123456789 |
billingEmail Required | ANS | 40 | Buyer E-mail | |
billingAddr Required | AN | 100 | Buyer Address | Jalan Bukit Berbunga 22 |
billingCity Required | A | 50 | Buyer City | Jakarta |
billingState Required | A | 50 | Billing State | DKI Jakarta |
billingPostCd Required | N | 10 | Billing Post Number | 12345 |
billingCountry Required | A | 10 | Billing Country | Indonesia |
cartData Required | JSONstring | 4000 | Cart Data | {"count":3,"item":[{"goods_id":30,"goods_name":"Beanie","goods_type":"Accessories","goods_amt":5000,"goods_sellers_id":"NICEPAY-NamaMerchant","goods_sellers_name":"NICEPAYSHOP","goods_quantity":1,"goods_url":"http://www.nicestore.com/product/beanie/"},..]} |
userIP Required for CC, E-Wallet, Payloan,QRIS | AN | 15 | User IP | 127.0.0.1 |
dbProcessUrl Required | ANS | 255 | Notification URL | https://merchant.com/dbProcessUrl |
merchantToken Required | AN | 255 | Merchant Token | 9b38b12e83b6ee124d4b549238f232c6179b168effc4ffb7f64d00c15f08e230 |
deliveryNm | A | 30 | Delivery Name | |
deliveryPhone | N | 15 | Delivery Phone | 08123456789 |
deliveryAddr | AN | 100 | Delviery Address | Jalan Bukit Berbunga 22 |
deliveryCity | A | 50 | Delivery City | Jakarta |
deliveryState | A | 50 | Delivery State | DKI Jakarta |
deliveryPostCd | N | 10 | Delivery Post Code | 12345 |
deliveryCountry | A | 10 | Delivery Country | Indonesia |
mitraCd Required | N | 2 | Mitra Code | KDVI |
instmntType Required | N | 8 | Request Date (YYYYMMDD) | 2 |
instmntMon Required | N | 6 | Request Time (HH24MISS) | 1 |
userSessionID | AN | 255 | ID User Session | 697D6922C961070967D3BA1BA5699C2C |
userAgent | ANS | 255 | User Agent | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML,like Gecko) Chrome/60.0.3112.101 Safari/537.36 |
userLanguage | ANS | 255 | User Language | ko-KR,en-US;q=0.8,ko;q=0.6,en;q=0.4 |
sellers | JSON String | 4000 | Seller Data | [{\"sellersId\":\"NICEPAY-NamaMerchant\",\"sellersNm\":\"NICEPAYSHOP\",\"sellersUrl\":\"http://nicestore.store/product/beanie/\",\"sellersEmail\":\"[email protected]\",\"sellersAddress\":{\"sellerNm\":\"NICEPAYSHOP\",\"sellerLastNm\":\"NICEPAYSHOP\",\"sellerAddr\":\"Jln. Kasablanka Kav 88\",\"sellerCity\":\"Jakarta\",\"sellerPostCd\":\"14350\",\"sellerPhone\":\"082111111111\",\"sellerCountry\":\"ID\"}}] |
Silakan kunjungi Payloan untuk mempelajari informasi umum mengenai metode pembayaran Payloan.
Berikut adalah response parameter dari hasil request parameter untuk mendaftarkan metode pembayaran Payloan.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | PAYLOANTES06202212051018325178 |
referenceNo | ANS | 40 | Merchant Ref. No. | ORD12345 |
payMethod | N | 2 | 06 | |
amt | N | 12 | Payment Amount | 10000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | null |
transTm | N | 6 | Transction Time (HH24MISS) | null |
description | AN | 100 | Transaction Description | null |
bankCd | A | 4 | null | |
vacctNo | N | 20 | Virtual Account Number | null |
mitraCd | A | 4 | KDVI | |
payNo | N | 12 | CVS Payment Number | null |
currency | A | 3 | Currency | null |
goodsNm | AN | 100 | Goods Name | null |
billingNm | A | 100 | Buyer Name | null |
payValidDt | N | 8 | Expiry Date (YYYYMMDD) | null |
payValidTm | N | 6 | Expiry Time (HH24MISS) | null |
requestURL | ANS | 360 | Request URL | null |
paymentExpDt | N | 6 | 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 |
Masing-masing Mitra yang bekerja sama dengan NICEPAY memiliki ketentuan yang berbeda-beda. Berikut adalah rincian ketentuan dari masing-masing Mitra.
CartData pada Registrasi Payloan berguna untuk mendeklarasikan item yang akan di checkout berserta rincian item dan harga per item-nya.
Parameter | Deskripsi | Contoh |
Count | Total jumlah dari keseluruhan cart data | 2 |
Item | Terbagi menjadi 4 macam parameter, yaitu img_url, goods_name, goods_detail dan goods_amt | - |
Penjelasan rincian pada parameter Item.
Parameter | Deskripsi | Contoh / Catatan |
goods_id | ID Barang | AA12345 |
goods_name | Nama Barang | Beanie |
goods_amt | Harga Barang | 5000 |
goods_type | Tipe Barang | others |
goods_quantity | Jumlah Barang | 1 |
goods_url | Tautan Barang | |
goods_sellers_id | ID Penjual Barang | NICEPAY-NamaMerchant |
goods_sellers_name | Nama Penjual Barang | NICEPAYSHOP |
CartData pada Registrasi Payloan berguna untuk mendeklarasikan item apa saja yang akan di-checkout berserta rincian dan harga per item.
Parameter | Deskripsi | Contoh |
Count | Total jumlah keseluruhan cart data | 2 |
Item | Parameter yang berisi rincian cart data, seperti img_url, goods_name, goods_detail , dan goods_amt | - |
Penjelasan rinci pada parameter Item.
Parameter | Deskripsi | Contoh / Catatan |
goods_id | ID Barang | AA12345 |
goods_name | Nama Barang | Beanie |
goods_amt | Harga Barang | 5000 |
goods_type | Tipe Barang | others |
goods_detail | Rincian Barang | AA1345678 |
goods_quantity | Jumlah Barang | 1 |
goods_url | Tautan Barang | http://nicestore.go/product/beanie/ |
goods_sellers_id | ID Penjual Barang | NICEPAY-NamaMerchant |
goods_sellers_name | Nama Penjual Barang | NICEPAYSHOP |
Payloan Seller Data berisi data informasi Seller yang dikirimkan oleh Seller kepada Partner NICEPAY untuk digunakan sebagai validasi Seller saat bertransaksi menggunakan metode pembayaran Payloan.
Parameter | Deskripsi | Contoh |
sellersId | ID Seller | SEL123 |
sellersNm | Nama Seller | Sellers 1 |
sellersEmail | Email Seller | |
sellersUrl | Tautan Seller | |
sellersAddress -> sellerNm | Nama Seller | Sellers |
sellersAddress -> sellerLastNm | Nama Belakang Seller | 1 |
sellersAddress -> sellerAddr | Alamat Seller | jalan berbangsa 1 |
sellersAddress -> sellerCity | Kota Asal Seller | Jakarta Barat |
sellersAddress -> sellerPostCd | Kode Pos Seller | 12344 |
sellersAddress -> sellerPhone | Telepon Seller | 08123456789 |
sellersAddress -> sellerCountry | Negara Asal Seller | ID |