Full Payment & Installment - Registration API Credit Card
Full Payment & Installment payment type is a choice of payment types using a Credit Card that pays a bill in full or installment (3, 6, or 12 months).
API Registration on Credit Card payment method is the first step on doing Payment API integration with 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 |
Following is a list of parameters needed to request the Registration on API Credit Card payment method.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20221202141217 |
iMid Required | AN | 10 | Merchant ID | IONPAYTEST |
payMethod Required | N | 2 | 01 | |
currency Required | A | 3 | Currency | IDR |
amt Required | N | 12 | Amount (number not in float format) | 10000 (Jumlah total amount goods dari cartData) |
referenceNo Required | ANS | 40 | Merchant's RefNo. | ordNo20221202141217 |
goodsNm Required | AN | 100 | Goods Name | Testing Transaction |
billingNm Required | A | 100 | Buyer Name | John Doe |
billingPhone Required | N | 15 | Buyer Phone No. | 2112345678 |
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 | 14350 |
billingCountry Required | A | 10 | Billing Country | Indonesia |
cartData Required | JSONstring | 4000 | Cart Data | {} |
instmntType Required | N | 2 | 1 | |
instmntMon Required | N | 2 | Installment Month 1: 1 Month/Full Payment, jika instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months | 1 |
recurrOpt Required | N | 2 | 0: Automatic Cancel 1: Do not cancel 2: Do not make token | 2 |
dbProcessUrl Required | ANS | 255 | Notification URL | https://merchant.com/dbProcessUrl |
userIP Required for CC, E-Wallet, Payloan, QRIS | AN | 15 | User IP | 127.0.0.1 |
merchantToken Required | AN | 255 | Merchant Token | c91e6531f6c84869439bc5ebe5389bd71e7752c054fc9dbfe193d087a1b797ae |
description | AN | 100 | Transaction Description | Test Transaction |
userSessionID | AN | 100 | User Session ID | userSessionID |
userAgent | ANS | 100 | User Agent | Mozilla |
userLanguage | A | 2 | User Language | en-US |
Notes for Credit Card Full Payment & Credit Card Installment
- For Credit Card - Full Payment payment type, on parameter instmntType can fill with 1 or empty (Null) and on parameter instmntMon can fill with 1 or empty (Null).
- For Credit Card - Installment payment type, on parameter instmntType can fill with 2 and on parameter instmntMon can fill with 3 (3 months), 6 (6 months) or 12 (12 months).
cartData on request parameter at Credit Card Registration uses to cover the goods or items will be paid to You Customer including the item detail and each item price.
Parameter | Description | Example |
Count | Total sum from the whole cart data | 2 |
Item | Divide into 4 types of parameter such as img_url, goods_name, goods_detail and goods_amt | - |
Detail explaination on Item parameter
Parameter | Description | Example |
img_url | URL item picture (Size 50px x 50px) | htttps://www.merchant.com/image_goods1.jpg |
goods_name | Item name | Nama Item-1 |
goods_detail | Item detail description | Detail Item-1 |
goods_amt | Item price | 1000 |
Following is the response parameter as result from request parameter on Credit Card Registration API.
Parameter | Type | Size | Description | Example / Notes |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | Result Message: Error Code | SUCCESS |
tXid | AN | 30 | Transaction ID | IONPAYTEST01202212151029182023 |
referenceNo | ANS | 40 | Merchant Ref. No | ordNo20221215101254 |
payMethod | N | 2 | 01 | |
amt | N | 12 | Payment Amount | 10000 |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221212 |
transTm | N | 6 | Transaction Time (HH24MISS) | 121212 |
description | AN | 100 | Transaction Description | Testing Transaction Credit Card |
bankCd | A | 4 | Bank Code | null |
vacctNo | N | 20 | Virtual Account | null |
mitraCd | A | 4 | Mitra Code | null |
payNo | N | 12 | CVS Payment Number | null |
currency | A | 3 | Currency | IDR |
goodsNm | AN | 100 | Goods Name | Goods For Testing Transaction |
billingNm | A | 100 | Buyer Name | John Doe |
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 |
Please check NICEPAY Code to know the common code also response code on credit card payment method or other NICEPAY payment methods.
After You done integrate this API, please continue to the Payment - API Credit Card process.