Registration - API GPN
Pada metode pembayaran GPN, Pelanggan memiliki banyak keuntungan selain aksesibilitas dan efisiensi karena Pelanggan dapat menggunakan kartu ATM berlogo GPN dari Bank apapun untuk melakukan transaksi melalui mesin EDC Bank apapun di seluruh Indonesia.
Registrasi GPN digunakan Merchant untuk terhubung dengan sistem API pembayaran GPN yang terdapat pada 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 |
Silakan kunjungi bagian GPN untuk mempelajari informasi umum mengenai metode pembayaran GPN.
Berikut ini adalah daftar parameter untuk melakukan request registrasi metode pembayaran GPN. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari NICEPAY. Informasi rincian terkait cartData bersifat opsional untuk ditambahkan.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20200813103605 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 09 | |
currency Required | A | 3 | Currency | IDR |
amt Required | N | 12 | Amount | 1000 |
referenceNo Required | ANS | 40 | Merchant's Ref. No. | order12345 |
goodsNm Required | AN | 100 | Goods Name | Testing Normal FULL PAYMENT GPN |
billingNm Required | A | 100 | Buyer Name | Customer Name |
billingPhone Required | N | 15 | Buyer Phone No. | 12345678 |
billingEmail Required | ANS | 40 | Buyer E-mail | |
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 | Optional |
instmntType Required | N | 2 | 1 | |
instmntMon Required | N | 2 | Installment Month | 1 |
recurrOpt Required | N | 2 | 0: Automatic Cancel 1: Do Not Cancel 2: Do Not Make Token | 2 |
dbProcessUrl | ANS | 255 | Notification URL | https://ptsv2.com/t/rizal/post |
merchantToken | AN | 255 | Merchant Token | 129b8f6ce5c94e7c6200dee63a42a05caa4175ba4523068651d3e17a3208772c |
userIP | AN | 15 | User IP | 127.0.0.1 |
Berikut adalah response parameter dari hasil request parameter untuk mendaftarkan metode pembayaran GPN.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
resultCd | N | 4 | 0000 | |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST09202212070935176733 |
referenceNo | ANS | 40 | Merchant Ref. No. | order12345 |
payMethod | N | 2 | 09 | |
amt | N | 12 | Payment Amount | 1000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221207 |
transTm | N | 6 | Transction Time (HH24MISS) | 093518 |
description | AN | 100 | Transaction Description | null |
vacctNo | N | 20 | VA Number | null |
mitraCd | A | 4 | null | |
payNo | N | 12 | CVS Payment Number | null |
currency | A | 3 | Currency | null |
goodsNm | AN | 100 | Goods Name | null |
billingNm | A | 100 | Buyer Name | null |
vacctValidDt | N | 8 | VA Expiry Date (YYYYMMDD) | null |
vacctValidTm | N | 6 | VA Expiry Time (HH24MISS) | 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 |
CartData pada Registrasi GPN berguna untuk mendeklarasikan item apa saja yang akan di-checkout berserta rincian dan harga per item.
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 |
img_url | URL Gambar Barang (Ukuran 50px x 50px) | htttps://www.merchant.com/image_goods1.jpg |
goods_name | Nama Barang | Nama Item-1 |
goods_detail | Deskripsi Detail Barang | Detail Item-1 |
goods_amt | Harga Barang | 1000 |