NICEPAY API
...
API Version 2 (V2)
Checkout API

Registration - API Checkout

17min

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 .



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

00

bankCd

A

4

Bank Code

CENA

currency

Required

AN

3

Currency

IDR

amt

Required

N

12

Transaction Amount

10000

referenceNo

Required

ANS

40

 Order Number

MerchantReferenceNumber001

merchantToken

Required

AN

255

 Token

4686062c297a3e48cf385953f411bbd48753bb70b041f2113a3e7c2e99c54f3c

callBackUrl

Required

AN

255

 Result Forward URL

https://www.merchant.com/callbackUrl/

dbProcessUrl

Required

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

john.doe@example.com

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 ()



fee

N

12

Service Fee



notaxAmt

N

12

Tax Free Amount



reqDt

N

8

Request Date

(YYYYMMDD)



reqTm

N

6

Request Time

(HH24MISS)



reqDomain

AN

100

Request Domain

merchant.com

reqServerIP

AN

15

Request Server IP

127.0.0.1

reqClientVer

AN

50

Request Client Version



userSessionID

AN

100

User Session ID



userAgent

AN

100

User Agent Information



userLanguage

A

2

User Language



sellers

Required For Payloan

JSON String

4000

Seller Data

[{"sellersId": "SEL123","sellersNm": "Sellers 1","sellersEmail":"sellers@test.com","sellersAddress": {"sellerNm": "Sellers","sellerLastNm": "1","sellerAddr": "jalan berbangsa 1","sellerCity":"Jakarta Barat","sellerPostCd": "12344","sellerPhone":"08123456789","sellerCountry": "ID"}}]

instmntType

Required For CC & Payloan

N

2

1 (For Pre-Auth & Recurring default 1)

instmntMon

Required For CC & Payloan 

N

2

Installment Month 1: 1 Month/Full , ifinstmntType: null/1

1 (For Pre-Auth & Recurring default 1)

recurrOpt

Required For CC

N

2

0: Automatic Cancel 1: Do not cancel 2: Do not make token

2

merFixAcctId

Required For VA (Fixed Type)

AN

40

 Reserved VA ID



(Max 8 Digit Numbers)

payValidDt

Required For CVS

N

8

CVS Expiry Date (YYYYMMDD)

20221212

payValidTm

Required For CVS

N

6

CVS Expiry Time (HH24MISS)

201012

paymentExpDt

Required For QRIS

N

8

QR  Expiry Date (YYYYMMDD)

20221208

paymentExpTm

Required For QRIS

N

6

QR  Expiry Time (HH24MISS)

092330

shopId

Required For QRIS

AN

25

Shop ID

216660000000833315280



Response Parameters for API Checkout Registration



Parameter

Type

Size

Description

Remark

resultCd

N

4

Result Code

0000

resultMsg

AN

255

SUCCESS

tXid

AN

30

Transaction ID

IONPAYTEST00202305161555223616



When Success

referenceNo

ANS

40

 Order Number

MerchantReferenceNumber001

payMethod

N

2

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




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




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

  • 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