Registration - API GPN

11min

About API for GPN Registration 
﻿
On ﻿ ﻿ ﻿, ﻿ ﻿ gets a lot of benefits other than accessibility and efficiency because ﻿ ﻿ can use an ATM card with ﻿ ﻿ logo for any ﻿ ﻿ using an EDC machine from any ﻿ throughout ﻿.
﻿
API for GPN Registration   
﻿
﻿﻿ Registration aims to connect ﻿ ﻿ to ﻿ ﻿ ﻿ ﻿ ﻿ available on ﻿. So ﻿ ﻿ ﻿ that prepares and hosts from ﻿ ﻿ side can integrate 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
﻿﻿ visit ﻿ GPN﻿ ﻿ to learn general ﻿ related ﻿ ﻿ ﻿.
﻿
Request Parameter for GPN Registration  
﻿
The following is a list of ﻿s for requesting registration of ﻿ ﻿ ﻿. This ﻿ is used through ﻿ ﻿ ﻿ platform as one of ﻿ stages so that ﻿ ﻿'s ﻿ can connect with ﻿ ﻿s. The cartData detail ﻿ is optional to be added.
Parameter
Type
Size
Description
Example / Notes
timeStamp 
﻿Required﻿
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20200813103605
iMid 
﻿Required﻿
AN
10
﻿﻿ ID	
﻿
IONPAYTEST
payMethod 
﻿Required﻿
N
2
﻿Payment Method Code﻿ 
﻿
09
currency 
﻿Required﻿
A
3
Currency
﻿
IDR
amt  
﻿Required﻿
N
12
Amount
﻿
1000
referenceNo
 Required﻿
ANS
40
﻿﻿'s Reference Number	
﻿
order12345
goodsNm ﻿
﻿Required﻿
AN
100
Goods Name	
﻿
Testing Normal FULL PAYMENT ﻿
billingNm
﻿Required﻿
A
100
Buyer Name	
﻿
﻿﻿ Name
billingPhone
 Required﻿
N
15
Buyer Phone Number
﻿
12345678
billingEmail
﻿Required﻿
ANS
40
Buyer E-Mail	
﻿
Email@merchant.com
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	
﻿
﻿﻿ 
cartData
﻿Required﻿
JSONstring

4000
Cart Data
﻿
Optional
instmntType
﻿Required﻿
N
2
﻿Installment Type Code﻿ 
﻿
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
﻿﻿ Token
129b8f6ce5c94e7c6200dee63a42a05caa4175ba4523068651d3e17a3208772c
userIP
AN
15
User IP
127.0.0.1
﻿
Response Parameter for GPN Registration 
﻿
The following is ﻿ response ﻿ from ﻿ result of ﻿ request ﻿ to register on ﻿ ﻿ ﻿.
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
IONPAYTEST09202212070935176733
referenceNo
ANS
40
﻿﻿ Reference Number
order12345
payMethod
N
2
﻿Payment Method Code﻿ 
09
amt
N
12
﻿﻿ Amount
1000
transDt
N
8
Transaction Date (YYYYMMDD)
20221207
transTm
N
6
Transaction Time (HH24MISS)
093518
description
AN
100
Transaction Description
null
vacctNo
N
20
VA Number
null
mitraCd
A
4
﻿Mitra Code﻿ 
null
payNo
N
12
CVS ﻿ 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 ﻿ 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
﻿
Sample JSON for GPN Registration  
﻿
JSON Request
JSON Response
Java Request
{
	"resultCd": "0000",
	"resultMsg": "SUCCESS",
	"tXid": "IONPAYTEST09202212070935176733",
	"referenceNo": "order12345",
	"payMethod": "09",
	"amt": "1000",
	"transDt": "20221207",
	"transTm": "093518",
	"description": null,
	"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": "IONPAYTEST09202212070935176733",
	"referenceNo": "order12345",
	"payMethod": "09",
	"amt": "1000",
	"transDt": "20221207",
	"transTm": "093518",
	"description": null,
	"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
}
﻿
﻿
Cart Data GPN Registration
﻿
CartData in ﻿ Registration is useful for declaring what items will be checked out along with item details and ﻿ price for each item.
Parameter
Description
Example
Count
The total number of all card data
2
Item
It is divided into 4 kinds of ﻿s, namely img_url, goods_name, goods_detail , and goods_amt
-
﻿
Detailed explanation on Item ﻿s.
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
﻿
cartData GPN 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"
        }  
        ] 
}
﻿

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)	20200813103605
iMid Required	AN	10	ID	IONPAYTEST
payMethod Required	N	2	Payment Method Code	09
currency Required	A	3	Currency	IDR
amt Required	N	12	Amount	1000
referenceNo Required	ANS	40	's Reference Number	order12345
goodsNm Required	AN	100	Goods Name	Testing Normal FULL PAYMENT
billingNm Required	A	100	Buyer Name	Name
billingPhone Required	N	15	Buyer Phone Number	12345678
billingEmail Required	ANS	40	Buyer E-Mail	Email@merchant.com
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
cartData Required	JSONstring	4000	Cart Data	Optional
instmntType Required	N	2	Installment Type Code	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	Token	129b8f6ce5c94e7c6200dee63a42a05caa4175ba4523068651d3e17a3208772c
userIP	AN	15	User IP	127.0.0.1

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	IONPAYTEST09202212070935176733
referenceNo	ANS	40	Reference Number	order12345
payMethod	N	2	Payment Method Code	09
amt	N	12	Amount	1000
transDt	N	8	Transaction Date (YYYYMMDD)	20221207
transTm	N	6	Transaction Time (HH24MISS)	093518
description	AN	100	Transaction Description	null
vacctNo	N	20	VA Number	null
mitraCd	A	4	Mitra Code	null
payNo	N	12	CVS 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 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

Parameter	Description	Example
Count	The total number of all card data	2
Item	It is divided into 4 kinds of s, namely img_url, goods_name, goods_detail , and goods_amt	-

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

API GPN

Payment - API GPN

Registration - API GPN

About API for GPN Registration

API for GPN Registration

Request Parameter for GPN Registration

Response Parameter for GPN Registration

Sample JSON for GPN Registration

Cart Data GPN Registration

Welcome to NICEPAY DOCS