Registration - API GPN
On the GPN payment method, the Customer gets a lot of benefits other than accessibility and efficiency because the Customer can use an ATM card with the GPN logo for any Bank transaction using an EDC machine from any bank throughout Indonesia.
GPN Registration aims to connect the Merchant to the GPN API Payment system available on NICEPAY. So the payment system that prepares and hosts from the Merchant side can integrate with the NICEPAY system.
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 |
Please visit the GPN section to learn general information related the GPN payment method.
The following is a list of parameters for requesting registration of the GPN payment method. This parameter is used through the API testing platform as one of the stages so that the merchant's system can connect with NICEPAY services. The cartData detail information is optional to be added.
Parameter | Type | Size | Description | Example / Notes |
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 RefNo. | 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 |
The following is the response parameter from the result of the request parameter to register on the GPN payment method.
Parameter | Type | Size | Description | Example / Notes |
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 in GPN Registration is useful for declaring what items will be checked out along with item details and the price for each item.
Parameter | Description | Example |
Count | The total number of all card data | 2 |
Item | It is divided into 4 kinds of parameters, namely img_url, goods_name, goods_detail , and goods_amt | - |
Detailed explanation on Item parameters.
Parameter | Description | Example |
img_url | URL Goods Picture (Size 50px x 50px) | htttps://www.merchant.com/image_goods1.jpg |
goods_name | Goods Name | Nama Item-1 |
goods_detail | Goods Detail Description | Detail Item-1 |
goods_amt | Goods Price | 1000 |