Registration - API Checkout

18min

About Registration - API Checkout
﻿
The purpose of this step on Registration - API Checkout is to register a 
﻿ request from your 
﻿ to us. So that your 
﻿ can pay 
﻿ 
﻿ amount billed on 
﻿ 
﻿ 
﻿ provided by 
﻿ .
Based on 
﻿ principle, all 
﻿s on 
﻿ 
﻿ 
﻿ have 
﻿ same 
﻿. The difference is just 
﻿ 
﻿ on each 
﻿. 
When 
﻿ 
﻿ 
﻿s with 
﻿ 
﻿ 
﻿, 
﻿ 
﻿ 
﻿s 
﻿ 
﻿ registration firsthand before 
﻿ 
﻿ can do 
﻿ 
﻿ 
﻿ on 
﻿ chosen 
﻿ through 
﻿ received 
﻿ link.
﻿
﻿
﻿ visit 
﻿ Payment - API Checkout﻿ 
﻿ to know further explanations related 
﻿ specific for 
﻿.
The following is 
﻿ 
﻿ that 
﻿ 
﻿ can choose to 
﻿ with 
﻿ 
﻿ 
﻿, there are:
﻿Credit Card - API Checkout﻿ 
﻿Virtual Account - API Checkout﻿ 
﻿Convenience Store - API Checkout﻿ 
﻿Direct Debit - API Checkout﻿ 
﻿E-Wallet - API Checkout﻿ 
﻿Payloan - API Checkout﻿ 
﻿GPN - API Checkout﻿ 
﻿QRIS - API Checkout﻿ 
﻿
﻿ continue reading this 
﻿ for more further detail about 
﻿ Registration.
﻿
Registration - API Checkout (All Payment Method)
﻿
To be able uses all 
﻿s on 
﻿ 
﻿, you are required to register 
﻿ 
﻿ with this 
﻿ Registration 
﻿. Here are 
﻿ 
﻿s:
API URL
/nicepay/redirect/v2/registration
Request Method 
﻿POST﻿
Header
﻿Content-Type: application/json﻿
Merchant Token
SHA256 (timestamp+ iMid+ referenceNo+ amt+ merchantKey)
﻿
Request Parameter for API Checkout Registration
﻿
Parameter
Type
Size
Description
Remark
iMid
﻿Required﻿
AN
10
﻿
﻿ ID
IONPAYTEST
timeStamp
﻿Required﻿
N
14
Request Timestamp
(YYYYMMDDHH24MISS)
20230516660517
payMethod
﻿Required﻿
N
2
﻿Payment Method Code﻿﻿
00
bankCd
A
4
﻿Bank Code﻿﻿
CENA
currency
﻿Required﻿
AN
3
Currency
IDR
amt
N
12
Transaction Amount
10000
referenceNo
﻿Required﻿
ANS
40
﻿
﻿ Order Number
MerchantReferenceNumber001
merchantToken
﻿Required﻿
AN
255
﻿
﻿ Token
4686062c297a3e48cf385953f411bbd48753bb70b041f2113a3e7c2e99c54f3c
callBackUrl
AN
255
﻿
﻿ Result Forward URL
https://www.merchant.com/callbackUrl/
dbProcessUrl
AN
255
﻿
﻿ Notification URL
https://www.merchant.com/dbProcessUrl
goodsNm
﻿Required﻿
AN
100
Goods Name
Merchant Goods 1
mitraCd
﻿Required For CVS, E-Wallet & Payloan﻿
AN
4
﻿Mitra Code﻿﻿
DANA
vacctValidDt
Required For VA﻿
N
8
VA Expiry Date
(YYYYMMDD)
20230531
vacctValidTm
﻿Required For VA﻿
N
8
VA Expiry Time
(HH24MISS)
235959
description
﻿Required﻿
AN
100
Transaction Description
This Is The Description Of The 
﻿ 
billingNm
﻿Required﻿
A
100
Billing Name
John Doe
billingPhone
﻿Required﻿
N
15
Billing Phone
08123456789
billingEmail
﻿Required﻿
AN
40
Billing E-mail
[email protected]
billingAddr
AN
100
Billing Address
Jln. Raya Casablanka Kav.88
billingCity
﻿Required﻿
A
50
Billing City
South Jakarta
billingState
﻿Required﻿
A
50
Billing State
DKI Jakarta
billingPostCd
﻿Required﻿
N
10
Billing Post Number
10200
billingCountry
﻿Required﻿
A
10
Billing Country
Indonesia
userIP
AN
15
User IP
127.0.0.1
cartData
﻿Required﻿
AN
4000
Cart Data
{\"count\":\"1\",\"item\":[{\"goods_id\":\"BB12345678\",\"goods_detail\":\"BB123456\",\"goods_name\":\"iPhone5S\",\"goods_amt\":\"10000\",\"goods_type\":\"Smartphone\",\"goods_url\":\"http://merchant.com/cellphones/iphone5s_64g\",\"goods_quantity\":\"1\",\"goods_sellers_id\":\"SEL123\",\"goods_sellers_name\":\"Sellers1\"}]}
deliveryNm
A
30
Delivery Name
﻿
﻿'s Name
deliveryPhone
N
15
Delivery Phone
08123456789
deliveryAddr
AN
100
Delivery Address
Jln. Dr. Saharjo No.88
deliveryCity
A
50
Delivery City
South Jakarta
deliveryState
A
50
Delivery State
DKI Jakarta
deliveryPostCd
N
10
Delivery Post Number
10201
deliveryCountry
A
10
Delivery Country
﻿
﻿ 
vat
N
12
Value Added Tax (
﻿)
(empty)
fee
N
12
Service Fee
(empty)
notaxAmt
N
12
Tax Free Amount 
(empty)
reqDt
N
8
Request Date
(YYYYMMDD)
(empty)
reqTm
N
6
Request Time
(HH24MISS)
(empty)
reqDomain
AN
100
Request Domain
(empty)
reqServerIP
AN
15
Request Server IP
(empty)
reqClientVer
AN
50
Request Client Version
(empty)
userSessionID
AN
100
User Session ID
(empty)
userAgent
AN
100
User Agent Information
(empty)
userLanguage
A
2
User Language
(empty)
﻿
Response Parameters for API Checkout Registration
﻿
Parameter
Type
Size
Description
Remark
resultCd
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
﻿Result Message﻿﻿
SUCCESS
tXid
AN
30
Transaction ID
IONPAYTEST00202305161555223616
﻿
When Success
referenceNo
ANS
40
﻿
﻿ Order Number
MerchantReferenceNumber001
payMethod
N
2
﻿Payment Method Code﻿﻿
00
﻿
When Success
amt
N
12
Amount
10000
﻿
When Success
transDt
N
8
Transaction Date
(YYYYMMDD)
20230516
﻿
When Success
transTm
N
6
Transaction Time
(HH24MISS)
135959
﻿
When Success
description
AN
100
Transaction Description
This Is The Description Of The 
﻿ 
﻿
When Success
currency
AN
3
Currency
IDR
﻿
When Success
goodsNm
AN
100
Goods Name
﻿
﻿ Goods 1
﻿
When Success
billingNm
A
100
Buyer Name
John Doe
﻿
When Success
payValidDt
N
8
CVS Expiry Date
(YYYYMMDD)
null
payValidTm
N
6
CVS Expiry Time
(HH24MISS)
null
paymentURL
AN
40
Redirect URL 
﻿ 
https://www.nicepay.co.id/nicepay/redirect/v2/payment
After your 
﻿ has been registered, direct your 
﻿ to our 
﻿ 
﻿ to 
﻿ with 
﻿ 
﻿. 
﻿ check 
﻿ Payment - API Checkout﻿ 
﻿ to view 
﻿ details.
﻿
Sample JSON API Checkout Registration
﻿
JSON Request
JSON Response
Java Request
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST00202305161555223616",
    "referenceNo": "MerchantReferenceNumber001",
    "payMethod": "00",
    "amt": "10000",
    "transDt": "20230516",
    "transTm": "165527",
    "description": "This Is The Description Of The Payment ",
    "currency": "IDR",
    "goodsNm": "Merchant Goods 1",
    "billingNm": "John Doe",
    "payValidDt": null,
    "payValidTm": null,
    "paymentURL": "https://www.nicepay.co.id/nicepay/redirect/v2/payment"
}
{
    "resultCd": "0000",
    "resultMsg": "SUCCESS",
    "tXid": "IONPAYTEST00202305161555223616",
    "referenceNo": "MerchantReferenceNumber001",
    "payMethod": "00",
    "amt": "10000",
    "transDt": "20230516",
    "transTm": "165527",
    "description": "This Is The Description Of The Payment ",
    "currency": "IDR",
    "goodsNm": "Merchant Goods 1",
    "billingNm": "John Doe",
    "payValidDt": null,
    "payValidTm": null,
    "paymentURL": "https://www.nicepay.co.id/nicepay/redirect/v2/payment"
}
﻿
﻿
Cart Data, Payloan Cart Data and Payloan Seller Data Chekout API
﻿
The Card Data on 
﻿ 
﻿ is useful for declaring what items will be checked out along with item details and prices per item. This Card Data applies to all 
﻿s, except 
﻿ using 
﻿ because 
﻿ 
﻿ 
﻿ has special Cart Data.
﻿
Cart Data
﻿
cartData must be released in 
﻿ string form.
Special characters are not supported in cartData.
Make sure that count is 
﻿ same as 
﻿ number of item object.
Make sure that goods_amt x goods_quantity is 
﻿ same as 
﻿ amt 
﻿.
Parameter
Description
Remark
Count
Total number of all cart data
2
Item
Divided into 5 kinds of 
﻿s, namely img_url, goods_name, goods_detail, goods_amt, and goods_quantity
-
Detailed explanation of the Item parameters.
Parameter
Description
Remark
img_url
Goods Image URL (Size 50px x 50px)
http://img.aaa.com/ima1.jpg
goods_name
Goods Name
Item 1 Name
goods_detail
Goods Detail Description
Item 1 Detail
goods_amt
Goods Amount
700
goods_quantity
Goods Quantity
1
Card Data
{
    "count": "2",  
    "item": [  
        {
            "img_url": "http://img.aaa.com/ima1.jpg",  
            "goods_name": "Item 1 Name",
            "goods_detail": "Item 1 Detail",
            "goods_amt": "700",
            "goods_quantity": "1"
        },  
        {
            "img_url": "http://img.aaa.com/ima2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "300",
            "goods_quantity": "1"
        }  
        ] 
} 
{
    "count": "2",  
    "item": [  
        {
            "img_url": "http://img.aaa.com/ima1.jpg",  
            "goods_name": "Item 1 Name",
            "goods_detail": "Item 1 Detail",
            "goods_amt": "700",
            "goods_quantity": "1"
        },  
        {
            "img_url": "http://img.aaa.com/ima2.jpg",
            "goods_name": "Item 2 Name",
            "goods_detail": "Item 2 Detail",
            "goods_amt": "300",
            "goods_quantity": "1"
        }  
        ] 
} 
﻿
﻿
Payloan Cart Data
﻿
Parameter
Description
count
Total Cart Data Count
item
List of Goods
item -> goods_id
Goods ID
item -> goods_detail
Goods Detail
item -> goods_name
Goods Name
item -> goods_amt
Goods Amount
item -> goods_type
Goods Type
item -> goods_url
Goods URL
item -> goods_quantity
Goods Quantity
item -> goods_sellers_id
Seller's ID
item -> goods_sellers_name
Seller's Name
cartData is mandatory to be released in 
﻿ string form.
JSON
{
  "count": "2",
  "item": [
    {
      "goods_id": "BB12345678",
      "goods_detail": "BB123456",
      "goods_name": "iPhone 5S",
      "goods_amt": "6000000",
      "goods_type": "Smartphone",
      "goods_url": "http://merchant.com/cel lphones/iphone5s_64g",
      "goods_quantity": "1",
      "goods_sellers_id": "SEL123",
      "goods_sellers_name": "Sellers 1"
    },
    {
      "goods_id": "AZ14565678",
      "goods_name": "Hailee Sneakers Blink Silver",
      "goods_amt": "250000",
      "goods_url": "http://merchant.com/fashion/shoes/sneakers-blinkshoes",
      "goods_type": "Sneakers",
      "goods_quantity": "2",
      "goods_sellers_id": "SEL124",
      "goods_ sellers_name": "Sellers 2"
    }
  ]
}
{
  "count": "2",
  "item": [
    {
      "goods_id": "BB12345678",
      "goods_detail": "BB123456",
      "goods_name": "iPhone 5S",
      "goods_amt": "6000000",
      "goods_type": "Smartphone",
      "goods_url": "http://merchant.com/cel lphones/iphone5s_64g",
      "goods_quantity": "1",
      "goods_sellers_id": "SEL123",
      "goods_sellers_name": "Sellers 1"
    },
    {
      "goods_id": "AZ14565678",
      "goods_name": "Hailee Sneakers Blink Silver",
      "goods_amt": "250000",
      "goods_url": "http://merchant.com/fashion/shoes/sneakers-blinkshoes",
      "goods_type": "Sneakers",
      "goods_quantity": "2",
      "goods_sellers_id": "SEL124",
      "goods_ sellers_name": "Sellers 2"
    }
  ]
}
﻿
cartData is specifically for 
﻿. 
Make sure 
﻿ count 
﻿s are based on 
﻿ goods' type number.
Make sure 
﻿ goods_sellers_id and goods_sellers_name are contained according to 
﻿ sellers on Registration.
﻿
Payloan Sellers Data
﻿
Parameter
Description
sellersId
Seller's ID
sellersNm
Seller's Name
sellersEmail
Seller's E-mail
sellersUrl
Seller's URL
sellersAddress -> sellerNm
Seller's Name
sellersAddress -> sellerLastNm
Seller's Last Name
sellersAddress -> sellerAddr
Seller's Address
sellersAddress -> sellerCity
Seller's City
sellersAddress -> sellerPostCd
Seller's Postal Code
sellersAddress -> sellerPhone
Seller's Phone
sellersAddress -> sellerCountry
Seller's Country
JSON
[
  {
    "sellersId": "SEL123",
    "sellersNm": "Sellers 1",
    "sellersEmail": "[email protected]",
    "sellersUrl": "http://nicestore.store",
    "sellersAddress": {
      "sellerNm": "Sellers",
      "sellerLastNm": "1",
      "sellerAddr": "jalan berbangsa 1",
      "sellerCity": "Jakarta Barat",
      "sellerPostCd": "12344",
      "sellerPhone": "08123456789",
      "sellerCountry": "ID"
    }
  },
  {
    "sellersId": "SEL124",
    "sellersNm": "Sellers 2",
    "sellersEmail": "[email protected]",
    "sellersUrl": "http://nicestore.store",
    "sellersAddress": {
      "sellerNm": "Sellers",
      "sellerLastNm": "2",
      "sellerAddr": "jalan berkelok 3",
      "sellerCity": "Jakarta Utara",
      "sellerPostCd": "12222",
      "sellerPhone": "081255556789",
      "sellerCountry": "ID"
    }
  }
]
[
  {
    "sellersId": "SEL123",
    "sellersNm": "Sellers 1",
    "sellersEmail": "sellers@test.com",
    "sellersUrl": "http://nicestore.store",
    "sellersAddress": {
      "sellerNm": "Sellers",
      "sellerLastNm": "1",
      "sellerAddr": "jalan berbangsa 1",
      "sellerCity": "Jakarta Barat",
      "sellerPostCd": "12344",
      "sellerPhone": "08123456789",
      "sellerCountry": "ID"
    }
  },
  {
    "sellersId": "SEL124",
    "sellersNm": "Sellers 2",
    "sellersEmail": "sellers2@test.com",
    "sellersUrl": "http://nicestore.store",
    "sellersAddress": {
      "sellerNm": "Sellers",
      "sellerLastNm": "2",
      "sellerAddr": "jalan berkelok 3",
      "sellerCity": "Jakarta Utara",
      "sellerPostCd": "12222",
      "sellerPhone": "081255556789",
      "sellerCountry": "ID"
    }
  }
]
﻿
﻿

Bank Indonesia already release API Standard relate to the Payment listed on Peraturan Anggota Dewan Gubernur No 23/15/PADG/2021 about Standar Nasional Open Application Interface Pembayaran (SNAP) Implementation.

As the form of suppport and compliance to Bank Indonesia Rules, NICEPAY drives all Merchant to conduct the migration to API SNAP BI.

All Merchants aim to complete the API SNAP BI migration on June 2024.

API URL	/nicepay/redirect/v2/registration
Request Method	POST
Header	Content-Type: application/json
Merchant Token	SHA256 (timestamp+ iMid+ referenceNo+ amt+ merchantKey)

Parameter	Description	Remark
Count	Total number of all cart data	2
Item	Divided into 5 kinds of s, namely img_url, goods_name, goods_detail, goods_amt, and goods_quantity	-

Parameter	Type	Size	Description	Remark
iMid Required	AN	10	ID	IONPAYTEST
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20230516660517
payMethod Required	N	2	Payment Method Code	00
bankCd	A	4	Bank Code	CENA
currency Required	AN	3	Currency	IDR
amt	N	12	Transaction Amount	10000
referenceNo Required	ANS	40	Order Number	MerchantReferenceNumber001
merchantToken Required	AN	255	Token	4686062c297a3e48cf385953f411bbd48753bb70b041f2113a3e7c2e99c54f3c
callBackUrl	AN	255	Result Forward URL	https://www.merchant.com/callbackUrl/
dbProcessUrl	AN	255	Notification URL	https://www.merchant.com/dbProcessUrl
goodsNm Required	AN	100	Goods Name	Merchant Goods 1
mitraCd Required For CVS, E-Wallet & Payloan	AN	4	Mitra Code	DANA
vacctValidDt Required For VA	N	8	VA Expiry Date (YYYYMMDD)	20230531
vacctValidTm Required For VA	N	8	VA Expiry Time (HH24MISS)	235959
description Required	AN	100	Transaction Description	This Is The Description Of The
billingNm Required	A	100	Billing Name	John Doe
billingPhone Required	N	15	Billing Phone	08123456789
billingEmail Required	AN	40	Billing E-mail	[email protected]
billingAddr	AN	100	Billing Address	Jln. Raya Casablanka Kav.88
billingCity Required	A	50	Billing City	South Jakarta
billingState Required	A	50	Billing State	DKI Jakarta
billingPostCd Required	N	10	Billing Post Number	10200
billingCountry Required	A	10	Billing Country	Indonesia
userIP	AN	15	User IP	127.0.0.1
cartData Required	AN	4000	Cart Data	{\"count\":\"1\",\"item\":[{\"goods_id\":\"BB12345678\",\"goods_detail\":\"BB123456\",\"goods_name\":\"iPhone5S\",\"goods_amt\":\"10000\",\"goods_type\":\"Smartphone\",\"goods_url\":\"http://merchant.com/cellphones/iphone5s_64g\",\"goods_quantity\":\"1\",\"goods_sellers_id\":\"SEL123\",\"goods_sellers_name\":\"Sellers1\"}]}
deliveryNm	A	30	Delivery Name	's Name
deliveryPhone	N	15	Delivery Phone	08123456789
deliveryAddr	AN	100	Delivery Address	Jln. Dr. Saharjo No.88
deliveryCity	A	50	Delivery City	South Jakarta
deliveryState	A	50	Delivery State	DKI Jakarta
deliveryPostCd	N	10	Delivery Post Number	10201
deliveryCountry	A	10	Delivery Country
vat	N	12	Value Added Tax ( )	(empty)
fee	N	12	Service Fee	(empty)
notaxAmt	N	12	Tax Free Amount	(empty)
reqDt	N	8	Request Date (YYYYMMDD)	(empty)
reqTm	N	6	Request Time (HH24MISS)	(empty)
reqDomain	AN	100	Request Domain	(empty)
reqServerIP	AN	15	Request Server IP	(empty)
reqClientVer	AN	50	Request Client Version	(empty)
userSessionID	AN	100	User Session ID	(empty)
userAgent	AN	100	User Agent Information	(empty)
userLanguage	A	2	User Language	(empty)

Parameter	Description
sellersId	Seller's ID
sellersNm	Seller's Name
sellersEmail	Seller's E-mail
sellersUrl	Seller's URL
sellersAddress -> sellerNm	Seller's Name
sellersAddress -> sellerLastNm	Seller's Last Name
sellersAddress -> sellerAddr	Seller's Address
sellersAddress -> sellerCity	Seller's City
sellersAddress -> sellerPostCd	Seller's Postal Code
sellersAddress -> sellerPhone	Seller's Phone
sellersAddress -> sellerCountry	Seller's Country

Registration - API Checkout

About Registration - API Checkout

Registration - API Checkout (All Payment Method)

Request Parameter for API Checkout Registration

Response Parameters for API Checkout Registration

Sample JSON API Checkout Registration

Cart Data, Payloan Cart Data and Payloan Seller Data Chekout API

Cart Data

Payloan Cart Data

Payloan Sellers Data

Welcome to NICEPAY DOCS