Full Payment & Installment - Registration API Credit Card

11 min

About Full Payment & Installment - Registration API Credit Card
﻿
Full ﻿ & Installment ﻿ type is a choice of ﻿ types using a ﻿ that pays a bill in full or installment (3, 6, or 12 months).
﻿
Full Payment & Installment - Registration API Credit Card
﻿
API Registration on ﻿ ﻿ is ﻿ first step on doing Payment API﻿ ﻿ with ﻿.

API Endpoint
/nicepay/direct/v2/registration
Request Method
﻿POST﻿
Description
Performs Transaction Regist to ﻿
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format
application/json
﻿
Request Parameter for Credit Card Registration
﻿
Following is a list of ﻿s needed to request ﻿ Registration on ﻿ ﻿ ﻿.
Parameter
﻿Type﻿
Size
Description
Example / Notes
timeStamp
﻿Required﻿
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20221202141217
iMid
﻿Required﻿
AN
10
﻿﻿ ID	
﻿
IONPAYTEST
payMethod
﻿Required﻿
N
2
﻿Payment Method Code﻿﻿
01
currency
﻿Required﻿
A
3
Currency
﻿
IDR
﻿amt ﻿
﻿Required﻿
N
12
Amount
(number not in float format)
10000 (Sum amount total goods from cartData)
referenceNo
﻿Required﻿
ANS
40
﻿﻿'s Reference Number	
﻿
ordNo20221202141217
goodsNm  ﻿
﻿Required﻿
AN
100
Goods Name	
﻿
Testing Transaction
billingNm 
﻿Required﻿
A
100
Buyer Name	
﻿
John Doe
billingPhone 
﻿Required﻿
N
15
Buyer Phone Number
﻿
2112345678
billingEmail 
﻿Required﻿
ANS
40
Buyer E-mail	
﻿
buyer@merchant.com
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	
﻿
﻿﻿ 
cartData
﻿Required﻿
JSONstring

4000
Cart Data
﻿
{}
instmntType
﻿Required﻿
N
2
﻿Installment Type Code﻿﻿
1
instmntMon
﻿Required﻿
N
2
Installment Month 
1: 1 Month/Full ﻿, if 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
﻿﻿ 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 ﻿ type, on instmntType ﻿ can fill with 1 or empty (Null) and on instmntMon ﻿ can fill with 1 or empty (Null).
For Credit Card - Installment ﻿ type, on instmntType ﻿ can fill with 2 and on instmntMon ﻿ can fill with 3 (3 months), 6 (6 months) or 12 (12 months).
Cart Data -  Registration API Credit Card
cartData on request ﻿ at ﻿ Registration uses to cover ﻿ goods or items will be paid to Your ﻿ including ﻿ item detail and each item price. 
Parameter
Description
Example
Count
Total sum from ﻿ whole cart data
2
Item
Divide into 4 types of ﻿ such as img_url, goods_name, goods_detail and goods_amt
-
﻿
Detail explaination on Item ﻿.
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
Sample JSON Cart Data
cartData Credit Card Registration
{
    "count": "2",  
    "item": [  
        {
            "img_url": "http://www.merchant.com/image_goods1.jpg",  
            "goods_name": "Item 1 Name",
            "goods_detail": "Item 1 Detail",
            "goods_amt": "1000"
        },  
        {
            "img_url": "http://www.merchant.com/image_goods2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "1000"
        }  
        ] 
} 
{
    "count": "2",  
    "item": [  
        {
            "img_url": "http://www.merchant.com/image_goods1.jpg",  
            "goods_name": "Item 1 Name",
            "goods_detail": "Item 1 Detail",
            "goods_amt": "1000"
        },  
        {
            "img_url": "http://www.merchant.com/image_goods2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "1000"
        }  
        ] 
} 
﻿
﻿
﻿Response Parameter for Credit Card Registration﻿
﻿
Following is ﻿ response ﻿ as result from request ﻿ on ﻿ Registration ﻿.
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
﻿﻿ Reference Number
ordNo20221215101254
payMethod
N
2
﻿Payment Method Code﻿﻿
01
amt
N
12
﻿﻿ Amount
10000
transDt
N
8
Transaction Date (YYYYMMDD)
20221212
transTm
N
6
Transaction Time (HH24MISS)
121212
description
AN
100
Transaction Description
Testing Transaction ﻿ 
bankCd
A
4
﻿Bank Code﻿﻿
null
vacctNo
N
20
﻿﻿ 
null
mitraCd
A
4
﻿Mitra Code﻿﻿
null
payNo
N
12
CVS ﻿ 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 ﻿ Expiry Date (YYYYMMDD)
null
paymentExpTm
N
6
QR ﻿ 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
﻿﻿ check NICEPAY Code﻿ to know ﻿ common code also response code on ﻿ ﻿ or other ﻿ ﻿s . 
﻿
Sample JSON Registration - API Credit Card
﻿
JSON Request
JSON Response
Java Request
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST01202212021455054652",
    "referenceNo": "ordNo20221202141217",
    "payMethod": "01",
    "amt": "5000",
    "transDt": "20221202",
    "transTm": "145507",
    "description": "Testing Registration Credit Card",
    "bankCd": null,
    "vacctNo": null,
    "mitraCd": null,
    "payNo": null,
    "currency": null,
    "goodsNm": null,
    "billingNm": null,
    "vacctValidDt": null,
    "vacctValidTm": null,
    "payValidDt": null,
    "payValidTm": null,
    "requestURL": null,
    "paymentExpDt": null,
    "paymentExpTm": null,
    "qrContent": null,
    "qrUrl": null
}
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST01202212021455054652",
    "referenceNo": "ordNo20221202141217",
    "payMethod": "01",
    "amt": "5000",
    "transDt": "20221202",
    "transTm": "145507",
    "description": "Testing Registration Credit Card",
    "bankCd": null,
    "vacctNo": null,
    "mitraCd": null,
    "payNo": null,
    "currency": null,
    "goodsNm": null,
    "billingNm": null,
    "vacctValidDt": null,
    "vacctValidTm": null,
    "payValidDt": null,
    "payValidTm": null,
    "requestURL": null,
    "paymentExpDt": null,
    "paymentExpTm": null,
    "qrContent": null,
    "qrUrl": null
}
﻿
After You done integrate this ﻿, please continue to ﻿ Payment - API Credit Card﻿ ﻿.

API Endpoint	/nicepay/direct/v2/registration
Request Method	POST
Description	Performs Transaction Regist to
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format	application/json

Parameter	Type	Size	Description	Example / Notes
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20221202141217
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	01
currency Required	A	3	Currency	IDR
amt Required	N	12	Amount (number not in float format)	10000 (Sum amount total goods from cartData)
referenceNo Required	ANS	40	's Reference Number	ordNo20221202141217
goodsNm Required	AN	100	Goods Name	Testing Transaction
billingNm Required	A	100	Buyer Name	John Doe
billingPhone Required	N	15	Buyer Phone Number	2112345678
billingEmail Required	ANS	40	Buyer E-mail	buyer@merchant.com
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
cartData Required	JSONstring	4000	Cart Data	{}
instmntType Required	N	2	Installment Type Code	1
instmntMon Required	N	2	Installment Month 1: 1 Month/Full , if 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	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

Parameter	Description	Example
Count	Total sum from whole cart data	2
Item	Divide into 4 types of such as img_url, goods_name, goods_detail and goods_amt	-

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

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	Reference Number	ordNo20221215101254
payMethod	N	2	Payment Method Code	01
amt	N	12	Amount	10000
transDt	N	8	Transaction Date (YYYYMMDD)	20221212
transTm	N	6	Transaction Time (HH24MISS)	121212
description	AN	100	Transaction Description	Testing Transaction
bankCd	A	4	Bank Code	null
vacctNo	N	20		null
mitraCd	A	4	Mitra Code	null
payNo	N	12	CVS 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 Expiry Date (YYYYMMDD)	null
paymentExpTm	N	6	QR 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

Registration - API Credit Card

Recurring - Registration API Credit Card

Full Payment & Installment - Registration API Credit Card

About Full Payment & Installment - Registration API Credit Card

Full Payment & Installment - Registration API Credit Card

Request Parameter for Credit Card Registration

Cart Data - Registration API Credit Card

Sample JSON Cart Data

﻿Response Parameter for Credit Card Registration﻿

Sample JSON Registration - API Credit Card

Welcome to NICEPAY DOCS

Response Parameter for Credit Card Registration