Full Payment & Installment - Registration API Credit Card

11 min

Tentang Full Payment & Installment - Registration API Credit Card
﻿
Pembayaran tipe Full Payment & Installment adalah pilihan tipe ﻿ menggunakan ﻿ ﻿ melakukan ﻿ suatu tagihan secara penuh atau secara cicilan (3, 6, atau 12 bulan). 
﻿
Full Payment & Installment - Registration API Credit Card
﻿
﻿Registrasi API dalam ﻿ ﻿ merupakan langkah awal dalam melakukan ﻿ Payment API﻿ dengan ﻿.

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
﻿
Berikut adalah daftar ﻿ ﻿ diperlukan untuk melakukan request Registrasi pada ﻿ ﻿ ﻿.
Parameter
﻿Tipe﻿
Ukuran
Deskripsi
Contoh / Catatan
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 (Jumlah total amount goods dari cartData)
referenceNo
﻿Required﻿
ANS
40
﻿﻿ 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 ﻿, 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
﻿﻿ 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
Catatan untuk Credit Card Full Payment & Credit Card Installment
Untuk jenis ﻿ Credit Card - Full Payment, pada ﻿ instmntType bisa diisi dengan 1 atau kosong (Null) dan pada ﻿ instmntMon bisa diisi dengan 1 atau kosong (Null).
Untuk jenis ﻿ Credit Card - Installment, pada ﻿ instmntType bisa diisi dengan 2 dan pada ﻿ instmntMon bisa diisi dengan 3 (3 bulan), 6 (6 bulan) atau 12 (12 bulan).
Cart Data -  Registration API Credit Card
cartData pada request ﻿ di Registrasi ﻿ berguna untuk meliputi barang atau item apa saja ﻿ akan dibayarkan oleh ﻿ ﻿ berserta rincian dan harga per item. ﻿
Parameter
Deskripsi
Contoh
Count
Total jumlah dari keseluruhan cart data
2
Item
Terbagi menjadi 4 macam ﻿, yaitu img_url, goods_name, goods_detail dan goods_amt
-
﻿
Penjelasan detil pada ﻿ 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
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﻿
﻿
Berikut adalah response ﻿ dari hasil request ﻿ pada ﻿ Registrasi ﻿.
Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
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
﻿﻿ memeriksa NICEPAY Code﻿ untuk mengetahui kode umum beserta kode response dalam ﻿ ﻿ ataupun ﻿ lainnya di ﻿.
﻿
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
}
﻿
Setelah ﻿ menyelesaikan ﻿ ﻿ ini, silakan melanjutkan ke ﻿ 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	Tipe	Ukuran	Deskripsi	Contoh / Catatan
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 (Jumlah total amount goods dari cartData)
referenceNo Required	ANS	40	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 , 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	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	Deskripsi	Contoh
Count	Total jumlah dari keseluruhan cart data	2
Item	Terbagi menjadi 4 macam , yaitu img_url, goods_name, goods_detail dan goods_amt	-

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

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
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

Tentang 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

Selamat Datang di NICEPAY DOCS

Response Parameter for Credit Card Registration