NICEPAY API

API Version 1 (V1)

V1 Enterprise

Credit Card - V1 Enterprise

56min

Credit Card
﻿
Transaction flow :
Request onePassToken.
Redirect to 3Ds / MIGS ﻿.
﻿﻿ input OTP on 3Ds ﻿.
﻿﻿ register ﻿.
﻿﻿ send ﻿.
﻿
Credit Card Flow V1 Enterprise
﻿
﻿﻿ Flow:
The ﻿ does ﻿.
The ﻿ requests ﻿ from ﻿.
The ﻿ registers ﻿ data.
The ﻿ sends response, card data based, to ﻿.
The ﻿ inputs card data.
The ﻿ sends data card data ﻿ to ﻿.
The ﻿ sends request by using Regist ﻿ to ﻿.
﻿﻿ saves ﻿ detail.
﻿﻿ sends response to ﻿.
The ﻿ requests ﻿ using ﻿ ﻿ to ﻿.
﻿﻿ requests 3Ds to ﻿.
﻿﻿ verifies ﻿ request.
﻿﻿ sends 3Ds URL response to ﻿.
﻿﻿ sends authentication ﻿ to ﻿.
The ﻿ sends OTP to ﻿.
The ﻿ input OTP and send ﻿ data to ﻿.
﻿﻿ validates OTP.
﻿﻿ sends 3Ds result to ﻿.
﻿﻿ calculates FDS.
﻿﻿ requests ﻿ to ﻿.
﻿﻿ ﻿es ﻿ ﻿.
﻿﻿ sends ﻿ response to ﻿.
﻿﻿ sends ﻿ ﻿ using callBackUrl and dbProcessUrl to ﻿.
The ﻿ receives ﻿.
The ﻿ requests ﻿ checking to ﻿.
﻿﻿ sends checking ﻿ response to ﻿.
The ﻿ receives final ﻿.
The ﻿ sends ﻿ result to ﻿.
﻿
Request Token
﻿
﻿﻿ need to request onePassToken for each Credit Card ﻿ using ﻿ V1 Enterprise.
API Specifications - Request Token
API Endpoint
/nicepay/api/onePassToken.do
Request Method application/x-www-form-urlencoded﻿
﻿POST﻿
Description
Request onePassToken for ﻿ Transaction.
Merchant Token
SHA256 (iMid+ referenceNo+ amt+ merchantKey)
Payment Methods
01 ﻿﻿
﻿
Request Parameter - Request Token
The Parameters below must be sent inside ‘jsonData’ ﻿ and formatted as JSON.
Token Request
curl --location --request POST 'https://www.nicepay.co.id/nicepay/api/onePassToken.do' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'jsonData={"iMid":"IONPAYTEST","referenceNo":"MerchantReferenceNumber001","amt":"10000","cardHolderNm":"John Doe","cardHolderEmail":"johndoe@gmail.com","cardNo":"5123450000000008","cardExpYymm":"3901","merchantToken":"f5d1a08fd497bf3f39e9a0027c0a6822109903cd95140c36db537b5977fb9652"}
curl --location --request POST 'https://www.nicepay.co.id/nicepay/api/onePassToken.do' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'jsonData={"iMid":"IONPAYTEST","referenceNo":"MerchantReferenceNumber001","amt":"10000","cardHolderNm":"John Doe","cardHolderEmail":"johndoe@gmail.com","cardNo":"5123450000000008","cardExpYymm":"3901","merchantToken":"f5d1a08fd497bf3f39e9a0027c0a6822109903cd95140c36db537b5977fb9652"}
﻿
Parameter
Type
Size
Description
Example Value
iMid
﻿Required﻿
AN
10
﻿﻿ ID
IONPAYTEST
merchantToken 
﻿Required﻿
AN
255
﻿﻿ Token
f5d1a08fd497bf3f39e9a0027c0a6822109903cd95140c36db537b5977fb9652
cardNo
Required
N
16
Card Number	
5123450000000008
cardExpYYmm
Required
N
4
Card Expiry (YYMM)	
3901
cardHolderNm
Required ﻿
AN
45
Card Holder Name	
John Doe
﻿
Only alphabet allowed
cardHolderEmail
Required﻿
ANS
100
Card Holder Email
johndoe@gmail.com
amt
Required﻿
N
12
﻿﻿ Amount	
10000
referenceNo
Required
ANS
40
﻿﻿ Order Number	
MerchantReferenceNumber001
instmntType
N
2
﻿Installment Type﻿﻿
1
instmntMon
N
2
Installment Month
1
﻿
Response Parameter - Request Token
Sample JSON Response
{
    "resultCd": "0000",
    "cardToken": "c3a4e1223361ce6b0ab92d9248152ebeb02ad1a8274ac20599d25da1d755254b",
    "resultMsg": "SUCCESS",
    "paymentType": "1"
}
{
    "resultCd": "0000",
    "cardToken": "c3a4e1223361ce6b0ab92d9248152ebeb02ad1a8274ac20599d25da1d755254b",
    "resultMsg": "SUCCESS",
    "paymentType": "1"
}
﻿
Parameter
Type
Size
Description
resultCd 
N
4
﻿Result Code﻿﻿
resultMsg
AN
255
﻿Result Message﻿﻿
cardToken
AN
64
One Time Use Transaction Token
paymentType
N
1
CC Authorization Type
Kindly check ﻿ paymentType ﻿ from onePassToken.do response. This will be needed for ﻿ next step to determine whether to use 3DS or MIGS.
paymentType
Description
1
3D Secure
2
KeyIn (Proceed to Registration without 3Ds/MIGS)
3
MiGS
﻿
3Ds Request
﻿
Proceed with this ﻿ when you get paymentType = 1 from onePassToken.do response.
3Ds Steps:
Send Request Parameters to 3Ds Request ﻿.
﻿﻿ will be redirect to 3Ds ﻿.
﻿﻿ input OTP.
﻿﻿ will send Response Parameter to callbackUrl.
﻿
API Specification - 3Ds
API Endpoint
/nicepay/api/secureVeRequest.do
Method
﻿application/x-www-form-urlencoded﻿
﻿Pop Up or Redirect﻿
Description
Request 3D  ﻿ for paymentType = 1 
Merchant Token
SHA256 (iMid+ referenceNo+ amt+ merchantKey)
﻿
Request Parameter - 3Ds
JSON
https://www.nicepay.co.id/nicepay/api/secureVeRequest.do?country={{country}}&callbackUrl={callbackUrl}&onePassToken={onePassToken}
https://www.nicepay.co.id/nicepay/api/secureVeRequest.do?country={{country}}&callbackUrl={callbackUrl}&onePassToken={onePassToken}
﻿
Parameter
Type
Size
Description
Example
country
﻿Required﻿
N
3
Country
360
callbackUrl 
﻿Required﻿
ANS
200
Callback URL
http://merchant.com/callback
onePassToken
Required﻿
AN
64
One time use ﻿ token
c5bd0b91bcc3d21358cd004c60e54
579441c23aa8e7553b41ce3402db1113fff
﻿
Response Parameter - 3Ds
JSON
https://www.merchant.com/callbackUrl?resultCd={resultCd}&resultMsg={resultMsg}&referenceNo={referenceNo}&merchantToken={merchantToken}
https://www.merchant.com/callbackUrl?resultCd={resultCd}&resultMsg={resultMsg}&referenceNo={referenceNo}&merchantToken={merchantToken}
﻿
Parameter
Type
Size
Description
resultCd 
N
4
﻿Result Code﻿﻿
resultMsg
AN
255
﻿Result Message﻿﻿
referenceNo
ANS
40
﻿﻿ Order Number
merchantToken
AN
255
﻿﻿ Token
﻿
MiGS Request
﻿
MiGS (MasterCard Internet Gateway Service) is a ﻿ from Mastercard to refund and monitor ﻿ ﻿ report based on ﻿ ﻿ between ﻿ and ﻿.
Currently, ﻿ using MPGS (Mastercard ﻿ Gateway Service) that ﻿ latest version of MiGS to increase ﻿ ﻿ security with 3Ds 2.0 feature. Although, MiGS API still used on MPGS ﻿.
Use this ﻿ if get paymentType = 3 from onePassToken.do response .
Steps:
Send Request Parameters to MIGS Request ﻿.
﻿﻿ will be redirect to MIGS ﻿.
﻿﻿ input OTP.
﻿﻿ will send Response Parameter to callbackUrl.
﻿
API Specifications - MiGS
API url
/nicepay/api/migsRequest.do
Request Method application/x-www-form-urlencoded﻿
﻿POST or Redirect﻿
Description
Request MIGS ﻿ for paymentType = 3
Merchant Token
SHA256 (iMid+ referenceNo+ amt+ merchantKey)
Payment Methods
01 ﻿﻿
﻿
Request Parameter - MiGS
Sample URL Parameter MIGS Request
https://www.nicepay.co.id/nicepay/api/migsRequest.do?instmntType=1&instmntMon=1&referenceNo={referenceNo}&cardCvv={cardCvv}&callbackUrl={callbackUrl}&onePassToken={onePassToken}
https://www.nicepay.co.id/nicepay/api/migsRequest.do?instmntType=1&instmntMon=1&referenceNo={referenceNo}&cardCvv={cardCvv}&callbackUrl={callbackUrl}&onePassToken={onePassToken}
﻿
Parameter
Type
Size
Description
Example
instmntType 
﻿Required﻿
N
2
﻿Installment Type﻿﻿
1
instmntMon
N
2
Installment Month	
1
referenceNo
Required﻿
ANS
40
﻿﻿ Order Number	
MerchantReferenceNumber001
cardCvv
N
3
Card CVV	
100
callbackUrl
Required
﻿
ANS
200
Callback URL for result	
http://merchant.com/callbackUrl
onePassToken
Required
﻿
AN
64
One Time Use Transaction Token	
d12b153b3dd50b1875e64ac17288a7cd33fd5511cf01924cac2ca7f345de8f08
﻿
Response Parameter - MiGS
Sample URL Parameter MIGS Response
https://www.merchant.com/callbackUrl?resultCd={resultCd}&resultMsg={resultMsg}&referenceNo={referenceNo}&merchantToken={merchantToken}
https://www.merchant.com/callbackUrl?resultCd={resultCd}&resultMsg={resultMsg}&referenceNo={referenceNo}&merchantToken={merchantToken}
﻿
Parameter
Type
Size
Description
resultCd 
N
4
﻿Result Code﻿﻿
resultMsg
AN
255
﻿Result Message﻿﻿
﻿
Credit Card Payment
﻿
API Specifications - Credit Card Payment
API Endpoint
/nicepay/api/onePass.do
Request Method application/x-www-form-urlencoded﻿
﻿POST﻿
Description
Register Transaction and Charge ﻿ using onePassToken
 
Merchant Token
SHA256 (iMid+ referenceNo+ amt+ merchantKey)
Payment Methods
01 ﻿﻿
﻿
Request Parameter - Credit Card Registration
Sample API Payment
Sample Java Request Credi Card
iMid: "IONPAYTEST"
payMethod: "01"
currency: "IDR"
amt: "10000"
referenceNo: "MerchantReferenceNumber001"
goodsNm: "Merchant Goods 1"
billingNm: "John Doe"
billingPhone: "08123456789"
billingEmail: "john.doe@example.com"
billingAddr: "Jln.Raya Kasablanka Kav.88"
billingCity: "South Jakarta"
billingState: "DKI Jakarta"
billingPostCd: "10200"
billingCountry: "Indonesia"
callBackUrl: "https://www.merchant.com/callbackUrl/"
dbProcessUrl: "https://www.merchant.com/dbProcessUrl/"
description: "This Is The Description Of The Payment"
merchantToken: "2349fcbd3a5b81d08ca719cc6d9c826f2f6f9d4de337b86e4019114aad6222b1"
userIP: "::1"
cartData: "{}"
instmntType: "1"
instmntMon: "1"
onePassToken: "9338d54573688ae18e175240b0257de48d89c6ef1c9c7b5c094dc4beed9e435f"
cardCvv: "100"
recurrOpt: "1"
iMid: "IONPAYTEST"
payMethod: "01"
currency: "IDR"
amt: "10000"
referenceNo: "MerchantReferenceNumber001"
goodsNm: "Merchant Goods 1"
billingNm: "John Doe"
billingPhone: "08123456789"
billingEmail: "john.doe@example.com"
billingAddr: "Jln.Raya Kasablanka Kav.88"
billingCity: "South Jakarta"
billingState: "DKI Jakarta"
billingPostCd: "10200"
billingCountry: "Indonesia"
callBackUrl: "https://www.merchant.com/callbackUrl/"
dbProcessUrl: "https://www.merchant.com/dbProcessUrl/"
description: "This Is The Description Of The Payment"
merchantToken: "2349fcbd3a5b81d08ca719cc6d9c826f2f6f9d4de337b86e4019114aad6222b1"
userIP: "::1"
cartData: "{}"
instmntType: "1"
instmntMon: "1"
onePassToken: "9338d54573688ae18e175240b0257de48d89c6ef1c9c7b5c094dc4beed9e435f"
cardCvv: "100"
recurrOpt: "1"
﻿
Parameter
Type
Size
Description
Example / Notes
iMid
﻿Required﻿
AN
2
﻿﻿ ID	
IONPAYTEST
payMethod
Required﻿
N
2
﻿Payment Method﻿﻿
01
currency
Required
﻿
A
40
Currency
IDR
amt
Required
﻿
N
12
Goods Amount
10000
referenceNo
Required﻿
ANS
40
﻿﻿ Order Number
MerchantReferenceNumber001
goodsNm
Required
﻿
AN
100
Goods Name	
﻿﻿ Goods 1
billingNm
Required
﻿
A
30
Billing Name
John Doe
billingPhone
Required
﻿
N
15
Billing Phone Number	
08123456789
billingEmail
Required﻿
ANS
40
Billing E-Mail	
john.doe@example.com
billingCity
Required﻿
N
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	
﻿﻿﻿
callBackUrl
Required
﻿
ANS
255
﻿﻿ Result Forward URL (On Browser)	
https://www.mechant.com/callbackUrl
dbProcessUrl
Required﻿
ANS
255
﻿﻿ Result Receive URL (Server Side)	
https://www.merchant.com/dbProcessUrl
description
Required﻿
AN
100
Description
This Is The Description Of The ﻿ 
merchantToken
Required
﻿
AN
255
﻿﻿ Token	
2349fcbd3a5b81d08ca719cc6d9c826f2f6f9d4de337b86e4019114aad6222b1
userIP
Required﻿
ANS
15
User IP	
127.0.0.1
cartData
Required
﻿
ANS
4000
Cart Data (JSON Format)	
{}
instmntType
Required
﻿
N
2
﻿Installment Type﻿﻿
1
instmntMon
Required
﻿
N
2
Installment Month	
1
cardCvv
N
3
Card CVV	
100
onePassToken
Required
﻿
AN
﻿
One Time Use Transaction Token
9338d54573688ae18e175240b0257de48d89c6ef1c9c7b5c094dc4beed9e435f
recurrOpt
Required For Recurring CC
﻿
N
2
0 : Automatic Cancel
1 : Do not cancel
2 : Do not make token
1
billingAddr
AN
255
Billing Address	
Jln. Raya Kasablanka Kav.88
deliveryNm
A
30
Delivery Name	
﻿﻿'s Name
deliveryPhone
N
15
Delivery Phone	
08123456789
deliveryAddr
AN
100
Delivery Address	
Jln. Dr. Saharjo No.88
deliveryEmail
AN
100
Delivery E-Mail	
example@merchant.com
deliveryCity
A
50
Delivery City	
South Jakarta
deliveryState
A
50
Delivery State	
DKI Jakarta
deliveryPostCd
N
10
Delivery Post Number	
10201
deliveryCountry
A
A
Delivery Country	
﻿﻿﻿
vat
N
12
﻿﻿ 
0
fee
N
12
Service Tax	
0
notaxAmt
N
12
Tax Free Amount	
0
reqDt
N
N
Request Date (YYYYMMDD)	
20230516
reqTm
N
N
Request Time (HH24MISS)	
135959
reqDomain
ANS
100
Request Domain	
www.merchant.com
reqServerIP
ANS
15
Request Server IP	
127.0.0.1
reqClientVer
ANS
50
Request Client Version	
1.0
userSessionID
AN
100
User Session ID
userSessionID
userAgent
ANS
100
User Agent Information
Mozilla
userLanguage
ANS
2
User Language
en-US
﻿
Response Parameter - Credit Card Payment
Sample Respone Payment
{
  "ccTransType": "1",
  "fee": null,
  "tXid": "IONPAYTEST01202305162316067832",
  "description": "Description",
  "notaxAmt": null,
  "cardNo": "51234500****0008",
  "issuBankCd": "CENA",
  "preauthToken": null,
  "cardExpYymm": "3901",
  "acquBankNm": "CIMB",
  "payMethod": "01",
  "callbackUrl": "https://www.merchant.com/callback/",
  "instmntMon": "1",
  "currency": "IDR",
  "issuBankNm": "BCA",
  "resultCd": "0000",
  "amount": "10000",
  "goodsNm": "Merchant Goods 1",
  "referenceNo": "MerchantReferenceNumber001",
  "transTm": "231641",
  "authNo": "041385",
  "recurringToken": "88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a" //Only For Recurring,
  "preAuth" : "c2921cc7a1967f905fd4f895f22f06c02d24adf8c9f7b169d6ef0c2c0b128549" //Only For PreAuth,
  "vat": null,
  "instmntType": "1",
  "resultMsg": "SUCCESS",
  "billingNm": "John Doe",
  "acquBankCd": "BNIA",
  "transDt": "20230516"
}
{
  "ccTransType": "1",
  "fee": null,
  "tXid": "IONPAYTEST01202305162316067832",
  "description": "Description",
  "notaxAmt": null,
  "cardNo": "51234500****0008",
  "issuBankCd": "CENA",
  "preauthToken": null,
  "cardExpYymm": "3901",
  "acquBankNm": "CIMB",
  "payMethod": "01",
  "callbackUrl": "https://www.merchant.com/callback/",
  "instmntMon": "1",
  "currency": "IDR",
  "issuBankNm": "BCA",
  "resultCd": "0000",
  "amount": "10000",
  "goodsNm": "Merchant Goods 1",
  "referenceNo": "MerchantReferenceNumber001",
  "transTm": "231641",
  "authNo": "041385",
  "recurringToken": "88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a" //Only For Recurring,
  "preAuth" : "c2921cc7a1967f905fd4f895f22f06c02d24adf8c9f7b169d6ef0c2c0b128549" //Only For PreAuth,
  "vat": null,
  "instmntType": "1",
  "resultMsg": "SUCCESS",
  "billingNm": "John Doe",
  "acquBankCd": "BNIA",
  "transDt": "20230516"
}
﻿
Parameter
Type
Size
Description
resultCd 
N
4
﻿Result Code﻿﻿
resultMsg
AN
255
﻿Result Message﻿﻿
tXid
AN
30
Transaction ID
referenceNo
ANS
40
﻿﻿ Order Number
payMethod
N
2
﻿Payment Method﻿﻿
amount
N
12
Transaction Amount
currency
AN
3
Currency
goodsNm
N
100
Goods Name
billingNm
N
30
Buyer Name
transDt
N
8
Transaction Date (YYYYMMDD)
transTm
N
6
Transaction Time (HH24MISS)
description
AN
100
Transaction Description
callbackUrl
ANS
100
Callback URL
authNo
N
10
Authorization Number
issuBankCd
A
4
﻿Issuing Bank Code﻿﻿
issuBankNm
A
255
Issuing ﻿ Name
acquBankCd
A
4
﻿Acquiring Bank Code﻿﻿
acquBankNm
A
255
Acquiring ﻿ Name
cardNo
ANS
20
Card Number (Masked)
instmntMon
N
2
Installment Month
instmntType
N
2
Installment Type
recurringToken
AN
64
Token for Recurring ﻿
preauthToken
AN
64
Token for Preauth ﻿
ccTransType
N
2
﻿Credit Card Transaction Type﻿
vat
N
12
﻿﻿ Number
fee
N
12
Service Fee
notaxAmt
N
12
Tax Free Amount
﻿
Credit Card Recurring
﻿
When ﻿ ﻿ signs contract as Recurring, ﻿ give a RecurringToken to ﻿ ﻿ ﻿ Response. The ﻿ can use RecurringToken for ﻿ next ﻿ ﻿ Request without input card detail, except cardCVV (Mandatory).
﻿
Recurring Issue
To do ﻿ Recurring ﻿, ﻿ ﻿ need recurringToken own from ﻿ ﻿ to use ﻿ ﻿ ﻿ continuously without reinputting ﻿ card data multiple times. recurringToken receives after ﻿ ﻿ ﻿s ﻿ initial ﻿. Following are ﻿ steps to get ﻿ recurringToken .
The ﻿ will input ﻿ data card such as cardNo and ExyMmYy through ﻿ Request Token (onePassToken.do).
The ﻿ will get cardToken.
Recurring ﻿ ﻿ on V1 Enterprise divide into 2 ﻿ , Direct 3Ds and Direct Non-3Ds.
If going through ﻿ 3Ds ﻿, then ﻿ card data will going through ﻿ security verification from ﻿ 3Ds Request (secureVeRequest.do) with an OTP also FDS (Fraud Detection System) ﻿ security.
If not going through 3Ds ﻿, then will not going through ﻿ security verification. 
The ﻿ does ﻿ with ﻿ ﻿ ﻿ (onePass.do) and get recurringToken to ﻿ ﻿ recurring ﻿.
API Specification - Recurring Issue
API Endpoint
/nicepay/api/recurringToken.do
Request Method  ﻿application/x-www-form-urlencoded﻿
﻿POST﻿
Description
recurringToken.do almost similar to onePassToken.do ﻿ difference whether use ﻿ card info or recurring token
Merchant Token
SHA256 (Merchant ID + Reference Number + Amount + Merchant Key)
﻿
Request Parameter - Recurring Issue
The ﻿ below must send on 'jsonData' ﻿ and with JSON format.
Sample Request Recurring Issue
curl --location --request POST 'https://www.nicepay.co.id/nicepay/api/onePassToken.do' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'jsonData={"iMid":"IONPAYTEST","merchantToken":"baf19eaed10d8539498cbe06ed19c50a60a587416d9c980abbb3c06b4eee51f5","referenceNo":"MerchantReferenceNumber001","amt":"10000","recurringToken":"88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a","instmntType":"1","instmntMon":"1"}'
curl --location --request POST 'https://www.nicepay.co.id/nicepay/api/onePassToken.do' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'jsonData={"iMid":"IONPAYTEST","merchantToken":"baf19eaed10d8539498cbe06ed19c50a60a587416d9c980abbb3c06b4eee51f5","referenceNo":"MerchantReferenceNumber001","amt":"10000","recurringToken":"88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a","instmntType":"1","instmntMon":"1"}'
﻿
Parameter
Type
Size
Description
Example / Notes
amt
Required
﻿
N
12
Amount
10000
referenceNo
Required
﻿
AN
40
﻿﻿ Order Number
MerchantReferenceNumber001
merchantToken
Required
﻿
AN
255
﻿﻿ Token
baf19eaed10d8539498cbe06ed19c50a60a587416d9c980abbb3c06b4eee51f5
iMid
Required
﻿
AN
10
﻿﻿ ID
IONPAYTEST
recurringToken
Required
﻿
AN
100
Recurring Token
88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a
instmntType
Required
﻿
AN
2
﻿Installment Type﻿﻿
1
instmntMon
Required
﻿
N
2
Installment Month	
1
cardHolderNm
Required
﻿
AN
45
Card Holder Name
John Doe
﻿
Only alphabet allowed
cardHolderEmail
Required
﻿
ANS
100
Card Holder Email
johndoe@gmail.com
﻿
Response Parameter - Recurring Issue
Sample Response Parameter
{
    "resultCd": "0000",
    "cardToken": "9338d54573688ae18e175240b0257de48d89c6ef1c9c7b5c094dc4beed9e435f",
    "resultMsg": "SUCCESS",
    "paymentType": "1"
}
{
    "resultCd": "0000",
    "cardToken": "9338d54573688ae18e175240b0257de48d89c6ef1c9c7b5c094dc4beed9e435f",
    "resultMsg": "SUCCESS",
    "paymentType": "1"
}
﻿
Parameter
Type
Size
Description
Remark
resultCd 
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
﻿Result Message﻿﻿
SUCCESS
cardToken
AN
64
Recurring Token
c954f03ef83a363f94fa26bef6ec4d08fa7693590a735386fcce6e2ef1caae8a
paymentType
AN
1
﻿CC Authorization type﻿﻿
1 : 3Ds
2 : KeyIn
﻿
﻿
Recurring Payment
After get ﻿ recurringToken from ﻿ initial ﻿ success or result from card registration ﻿, ﻿ ﻿ will use that recurringToken to execute ﻿ next schedule. Following is ﻿ ﻿ steps on ﻿ ﻿ using ﻿ recurringToken.
﻿﻿ recurringToken gain from ﻿ initial ﻿ ﻿ (recurringToken.do) or ﻿ result from card registration ﻿ (tokenize.do).
Next, cardToken will gain and save on ﻿ database to use on ﻿ next ﻿.
Special for ﻿ 3Ds ﻿, card data will go through ﻿ security verification from ﻿ 3Ds Request (secureVeRequest.do) with an OTP also FDS (Fraud Detection System) ﻿ security using cardToken gain from ﻿ previous step.
The ﻿ will ﻿ using ﻿ Recurring ﻿ (recurringTrans.do).
This ﻿ will ﻿ continuously on ﻿ recurring period.
On ﻿ next recurring ﻿, recurringToken will originate from recurringToken.do . onePass.do only use during ﻿ first recurring ﻿.
API Specifications - Recurring Payment
API Endpoint
/nicepay/api/recurringTrans.do
Method
﻿application/x-www-form-urlencoded﻿
﻿POST﻿
Merchant Token
SHA256(Merchant ID + Reference Number + Amount + MerchantKey)
Description
The ﻿ ﻿ for ﻿ Recurring or ﻿ with Recurring Token
﻿
Request Parameter- Recurring Payment
Sample Request Recurring Payment
Sample Java Request Recurring Paymen
// Payment Mandatory Field
nicePay.setPayMethod("01");
nicePay.setCurrency("IDR");
nicePay.setAmt("10000");
nicePay.setInstmntMon("1");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setGoodsNm("Merchant Goods 1");
nicePay.setBillingNm("John Doe");
nicePay.setBillingEmail("john.doe@example.com");
nicePay.setBillingPhone("08123456789");
nicePay.setBillingAddr("Jln. Raya Kasablanka Kav.88");
nicePay.setBillingCity("South Jakarta");
nicePay.setBillingState("DKI Jakarta");
nicePay.setBillingPostCd("10200");
nicePay.setBillingCountry("Indonesia");
nicePay.setDeliveryNm("Merchant's Name");
nicePay.setDeliveryPhone("08123456789");
nicePay.setDeliveryAddr("Jln.Dr. Saharjo No.88");
nicePay.setDeliveryCity("South Jakarta");
nicePay.setDeliveryState("DKI Jakarta");
nicePay.setDeliveryPostCd("10201");
nicePay.setDeliveryCountry("Indonesia");
nicePay.setCallBackUrl(merchantDomain + "callback");
nicePay.setDbProcessUrl(merchantDomain + "dbprocess");
nicePay.setVat("0");
nicePay.setFee("0");
nicePay.setNotaxAmt("0");
nicePay.setDescription("This Is The Description Of The Payment");
nicePay.setUserIP("127.0.0.1");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getReferenceNo()));
nicePay.setCartData("{}");
nicePay.setInstmntMon("1");
nicePay.setInstmntType("1");
nicePay.setRecurrOpt("1"); // For Recurring Only
nicePay.setCardCvv("100");
nicePay.setRecurringToken("88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a");
nicePay.setCardExpYymm("3901")

// Payment Optional Field
nicePay.setReqDt("20230516");
nicePay.setReqTm("135959");
nicePay.setReqDomain("merchant.com");
nicePay.setReqServerIP("127.0.0.1");
nicePay.setReqClientVer("1.0");
nicePay.setUserSessionID("userSessionID");
nicePay.setUserAgent("Mozilla");
nicePay.setUserLanguage("en-US");
nicePay.setMerFixAcctId("00000001");
nicePay.setPaymentExpiryDt("20230531");
nicePay.setPaymentExpiryTm("235959");

// Payment Request
nicePay.payment();

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String ccTransType = nicePay.Get("ccTransType");
String fee = nicePay.Get("fee");
String tXid = nicePay.Get("tXid");
String description = nicePay.Get("description");
String notaxAmt = nicePay.Get("notaxAmt");
String cardNo = nicePay.Get("cardNo");
String issuBankCd = nicePay.Get("issuBankCd");
String cardExpYymm = nicePay.Get("cardExpYymm");
String acquBankNm = nicePay.Get("acquBankNm");
String payMethod = nicePay.Get("payMethod");
String callbackUrl = nicePay.Get("callbackUrl");
String instmntMon = nicePay.Get("instmntMon");
String currency = nicePay.Get("currency");
String issuBankNm = nicePay.Get("issuBankNm");
String resultCd = nicePay.Get("resultCd");
String amount = nicePay.Get("amount");
String goodsNm = nicePay.Get("goodsNm");
String referenceNo = nicePay.Get("referenceNo");
String transTm = nicePay.Get("transTm");
String authNo = nicePay.Get("authNo");
String vat = nicePay.Get("vat");
String instmntType = nicePay.Get("instmtnType");
String resultMsg = nicePay.Get("resultMsg");
String billingNm = nicePay.Get("billingNm");
String acquBankCd = nicePay.Get("acquBankCd");
String transDt = nicePay.Get("transDt");
// Payment Mandatory Field
nicePay.setPayMethod("01");
nicePay.setCurrency("IDR");
nicePay.setAmt("10000");
nicePay.setInstmntMon("1");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setGoodsNm("Merchant Goods 1");
nicePay.setBillingNm("John Doe");
nicePay.setBillingEmail("john.doe@example.com");
nicePay.setBillingPhone("08123456789");
nicePay.setBillingAddr("Jln. Raya Kasablanka Kav.88");
nicePay.setBillingCity("South Jakarta");
nicePay.setBillingState("DKI Jakarta");
nicePay.setBillingPostCd("10200");
nicePay.setBillingCountry("Indonesia");
nicePay.setDeliveryNm("Merchant's Name");
nicePay.setDeliveryPhone("08123456789");
nicePay.setDeliveryAddr("Jln.Dr. Saharjo No.88");
nicePay.setDeliveryCity("South Jakarta");
nicePay.setDeliveryState("DKI Jakarta");
nicePay.setDeliveryPostCd("10201");
nicePay.setDeliveryCountry("Indonesia");
nicePay.setCallBackUrl(merchantDomain + "callback");
nicePay.setDbProcessUrl(merchantDomain + "dbprocess");
nicePay.setVat("0");
nicePay.setFee("0");
nicePay.setNotaxAmt("0");
nicePay.setDescription("This Is The Description Of The Payment");
nicePay.setUserIP("127.0.0.1");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getReferenceNo()));
nicePay.setCartData("{}");
nicePay.setInstmntMon("1");
nicePay.setInstmntType("1");
nicePay.setRecurrOpt("1"); // For Recurring Only
nicePay.setCardCvv("100");
nicePay.setRecurringToken("88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a");
nicePay.setCardExpYymm("3901")

// Payment Optional Field
nicePay.setReqDt("20230516");
nicePay.setReqTm("135959");
nicePay.setReqDomain("merchant.com");
nicePay.setReqServerIP("127.0.0.1");
nicePay.setReqClientVer("1.0");
nicePay.setUserSessionID("userSessionID");
nicePay.setUserAgent("Mozilla");
nicePay.setUserLanguage("en-US");
nicePay.setMerFixAcctId("00000001");
nicePay.setPaymentExpiryDt("20230531");
nicePay.setPaymentExpiryTm("235959");

// Payment Request
nicePay.payment();

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String ccTransType = nicePay.Get("ccTransType");
String fee = nicePay.Get("fee");
String tXid = nicePay.Get("tXid");
String description = nicePay.Get("description");
String notaxAmt = nicePay.Get("notaxAmt");
String cardNo = nicePay.Get("cardNo");
String issuBankCd = nicePay.Get("issuBankCd");
String cardExpYymm = nicePay.Get("cardExpYymm");
String acquBankNm = nicePay.Get("acquBankNm");
String payMethod = nicePay.Get("payMethod");
String callbackUrl = nicePay.Get("callbackUrl");
String instmntMon = nicePay.Get("instmntMon");
String currency = nicePay.Get("currency");
String issuBankNm = nicePay.Get("issuBankNm");
String resultCd = nicePay.Get("resultCd");
String amount = nicePay.Get("amount");
String goodsNm = nicePay.Get("goodsNm");
String referenceNo = nicePay.Get("referenceNo");
String transTm = nicePay.Get("transTm");
String authNo = nicePay.Get("authNo");
String vat = nicePay.Get("vat");
String instmntType = nicePay.Get("instmtnType");
String resultMsg = nicePay.Get("resultMsg");
String billingNm = nicePay.Get("billingNm");
String acquBankCd = nicePay.Get("acquBankCd");
String transDt = nicePay.Get("transDt");
﻿
Parameter
Type
Size
Description
Example / Notes
iMid
﻿Required﻿
AN
2
﻿﻿ ID	
IONPAYTEST
payMethod
Required﻿
N
2
﻿Payment Method﻿﻿
01
currency
Required
﻿
A
40
Currency
IDR
amt
Required
﻿
N
12
Goods Amount
10000
referenceNo
Required﻿
ANS
40
﻿﻿ Order Number
MerchantReferenceNumber001
goodsNm
Required
﻿
AN
100
Goods Name	
﻿﻿ Goods 1
billingNm
Required
﻿
A
30
Billing Name
John Doe
billingPhone
Required
﻿
N
15
Billing Phone Number	
08123456789
billingEmail
Required﻿
ANS
40
Billing E-Mail	
john.doe@example.com
billingCity
Required﻿
N
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	
﻿﻿﻿
callBackUrl
Required
﻿
ANS
255
﻿﻿ Result Forward URL (On Browser)	
https://www.mechant.com/callbackUrl
dbProcessUrl
Required﻿
ANS
255
﻿﻿ Result Receive URL (Server Side)	
https://www.merchant.com/dbProcessUrl
description
Required﻿
AN
100
Description
This Is The Description Of The ﻿﻿
merchantToken
Required
﻿
AN
255
﻿﻿ Token	
2349fcbd3a5b81d08ca719cc6d9c826f2f6f9d4de337b86e4019114aad6222b1
userIP
Required﻿
ANS
15
User IP	
127.0.0.1
cartData
Required
﻿
ANS
4000
Cart Data (JSON Format)	
{}
instmntType
Required
﻿
N
2
﻿Installment Type﻿﻿
1
instmntMon
Required
﻿
N
2
Installment Month	
1
cardCvv
N
3
Card CVV	
100
recurringToken
﻿Required
﻿
AN
64
Recurring Token
88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a
recurrOpt
Required For Recurring CC
﻿
N
2
0 Automatic Cancel
1 Do Not Cancel
2 Do Not Make Token
1
billingAddr
AN
255
Billing Address	
Jln. Raya Kasablanka Kav.88
deliveryNm
A
30
Delivery Name	
﻿﻿'s Name
deliveryPhone
N
15
Delivery Phone	
08123456789
deliveryAddr
AN
100
Delivery Address	
Jln. Dr. Saharjo No.88
deliveryEmail
ANS
100
Delivery E-Mail	
example@merchant.com
deliveryCity
A
50
Delivery City	
South Jakarta
deliveryState
A
50
Delivery State	
DKI Jakarta
deliveryPostCd
N
10
Delivery Post Number	
10201
deliveryCountry
A
A
Delivery Country	
﻿﻿﻿
vat
N
12
﻿﻿ 
0
fee
N
12
Service Tax	
0
notaxAmt
N
12
Tax Free Amount	
0
reqDt
N
N
Request Date (YYYYMMDD)	
20230516
reqTm
N
N
Request Time (HH24MISS)	
135959
reqDomain
ANS
100
Request Domain	
www.merchant.com
reqServerIP
ANS
15
Request Server IP	
127.0.0.1
reqClientVer
ANS
50
Request Client Version	
1.0
userSessionID
AN
100
User Session ID
userSessionID
userAgent
ANS
100
User Agent Information
Mozilla
userLanguage
ANS
2
User Language
en-US
﻿
Response Parameter - Recurring Payment
Sample Response Recurring Payment
{
    "issuBankNm": "BCA",
    "resultCd": "0000",
    "amount": "10000",
    "ccTransType": "2",
    "authNo": "048797",
    "referenceNo": "MerchantReferenceNumber001",
    "transTm": "224646",
    "fee": null,
    "vat": null,
    "tXid": "IONPAYTEST01202305212240279260",
    "description": "This Is The Description Of The Payment",
    "notaxAmt": null,
    "cardNo": "51234500****0008",
    "issuBankCd": "CENA",
    "instmntType": "1",
    "resultMsg": "SUCCESS",
    "acquBankCd": "BNIA",
    "cardExpYymm": "3901",
    "acquBankNm": "CIMB",
    "payMethod": "01",
    "callbackUrl": "https://www.merchant.com/callbackUrl/",
    "instmntMon": "1",
    "transDt": "20230516"
}
{
    "issuBankNm": "BCA",
    "resultCd": "0000",
    "amount": "10000",
    "ccTransType": "2",
    "authNo": "048797",
    "referenceNo": "MerchantReferenceNumber001",
    "transTm": "224646",
    "fee": null,
    "vat": null,
    "tXid": "IONPAYTEST01202305212240279260",
    "description": "This Is The Description Of The Payment",
    "notaxAmt": null,
    "cardNo": "51234500****0008",
    "issuBankCd": "CENA",
    "instmntType": "1",
    "resultMsg": "SUCCESS",
    "acquBankCd": "BNIA",
    "cardExpYymm": "3901",
    "acquBankNm": "CIMB",
    "payMethod": "01",
    "callbackUrl": "https://www.merchant.com/callbackUrl/",
    "instmntMon": "1",
    "transDt": "20230516"
}
﻿
Parameter
Type
Size
Description
resultCd 
N
4
﻿Result Code﻿﻿
resultMsg
AN
255
﻿Result Message﻿﻿
tXid
AN
30
Transaction ID
referenceNo
ANS
40
﻿﻿ Order Number
payMethod
N
2
﻿Payment Method﻿﻿
amount
N
12
Transaction Amount
currency
AN
3
Currency
goodsNm
N
100
Goods Name
billingNm
N
30
Buyer Name
transDt
N
8
Transaction Date (YYYYMMDD)
transTm
N
6
Transaction Time (HH24MISS)
description
AN
100
Transaction Description
callbackUrl
ANS
100
Callback URL
authNo
N
10
Authorization Number
issuBankCd
A
4
﻿Issuing Bank Code﻿﻿
issuBankNm
A
255
Issuing ﻿ Name
acquBankCd
A
4
﻿Acquiring Bank Code﻿﻿
acquBankNm
A
255
Acquiring ﻿ Name
cardNo
ANS
20
Card Number (Masked)
instmntMon
N
2
Installment Month
instmntType
N
2
﻿Installment Type﻿﻿
ccTransType
N
2
﻿﻿ Transaction Type
vat
N
12
﻿﻿ Number
fee
N
12
Service Fee
notaxAmt
N
12
Tax Free Amount
﻿
Generate Recurring Token Without First Payment
This ﻿ uses specific on ﻿ with Recurring type to create ﻿ recurringToken without doing ﻿ ﻿ ﻿ ﻿ beforehand, but only going through ﻿ card ﻿ registration ﻿. recurringToken that created successfully can be used for ﻿ ﻿ (recurringTrans.do).
API Specification - Generate Recurring Token Without First Payment
API Endpoint
/nicepay/api/tokenize.do
Method  ﻿
﻿application/x-www-form-urlencoded﻿
﻿POST﻿
Description
To generate ﻿'s Recurring Token without ﻿ through ﻿ ﻿ ﻿ beforehand.

Merchant Token
SHA256 (Merchant ID + Card No + Card Exp Yymm + Merchant Key)
﻿
Request Parameter - Generate Recurring Token
Sample Java Request Generate Recurring Token
// Request Mandatory Field
nicePay.setImid("IONPAYTEST");
nicePay.setCardNo ("5289190008221516");
nicePay.setCardExpYymm ("2012");
nicePay.setBillingNm("anyone");

nicePay.setMerchantToken(nicePay.makeToken(nicePay.getCardNo(), nicePay.getCardExpYymm()));

// Optional Field
nicePay.setCardHolderNm("John Doe");
nicePay.setCardHolderEmail("jhondoe@gmail.com");

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String recurringToken = nicePay.Get("recurringToken");
// Request Mandatory Field
nicePay.setImid("IONPAYTEST");
nicePay.setCardNo ("5289190008221516");
nicePay.setCardExpYymm ("2012");
nicePay.setBillingNm("anyone");

nicePay.setMerchantToken(nicePay.makeToken(nicePay.getCardNo(), nicePay.getCardExpYymm()));

// Optional Field
nicePay.setCardHolderNm("John Doe");
nicePay.setCardHolderEmail("jhondoe@gmail.com");

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String recurringToken = nicePay.Get("recurringToken");
﻿
Parameter
Type
Size
Description
Contoh / Catatan
iMid
﻿Required﻿
AN
10
﻿﻿ ID	
IONPAYTEST
merchantToken
﻿Required﻿
AN
255
﻿﻿ Token
b63d66156715bf8c9d851e76
e61a42ce7efb815a91843b75
35c5bcde8490cb4d
cardNo
﻿Required﻿
N
16
Card Number
552103******6573
cardExpYymm
﻿Required﻿
N
4
Card Expired YY/MM
2012
billingNm
﻿Required﻿
A
30
Billing Name
John Doe
cardHolderNm
﻿Required﻿
AN
45
Card Holder Name
John Doe
﻿
﻿
cardHolderEmail
﻿Required﻿
ANS
100
Cardholder Email
johndoe@gmail.com
﻿
Response Parameter - Generate Recurring Token
Sample Java Response Generate Recurring Token
String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String recurringToken = nicePay.Get("recurringToken");
String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String recurringToken = nicePay.Get("recurringToken");
﻿
Parameter
Type
Size
Description
Example / Notes
resultCode
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
Result Message
SUCCESS
transDt
N
8
Transaction Date
20180604
When Success
transTm
N
6
Transaction Time
141806
When Success
recurringToken
AN
10
Recurring Token
75d5220c439b83359ed440ab
12b713ed273feb455cc278fe0
0209e57dfe84cjk
When Success
﻿
Check Recurring Token
API Specification - Check Recurring Token
API Endpoint
/nicepay/api/checkToken.do
Method
﻿application/x-www-form-urlencoded﻿
﻿POST﻿
Merchant Token
SHA256(Merchant ID + Recurring Token + MerchantKey)
Deskripsi
To check ﻿ Recurring Token on ﻿ ﻿.
﻿
Request Parameter - Check Recurring Token
Sample Java Request Check Recurring Token
// Request Mandatory Field
nicePay.setImid("IONPAYTEST");
nicePay.setRecurringToken("f46225e4bb06745ef2e238ddb65ceab1ba4556578bf3b3452964e488f0c8ec36");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getRecurringToken()));

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String recurringToken = nicePay.Get("recurringToken");
String billingNm= nicePay.Get("billingNm");
String billingEmail = nicePay.Get("billingEmail");
// Request Mandatory Field
nicePay.setImid("IONPAYTEST");
nicePay.setRecurringToken("f46225e4bb06745ef2e238ddb65ceab1ba4556578bf3b3452964e488f0c8ec36");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getRecurringToken()));

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String recurringToken = nicePay.Get("recurringToken");
String billingNm= nicePay.Get("billingNm");
String billingEmail = nicePay.Get("billingEmail");
﻿
Parameter
Type
Size
Description
Example / Notes
iMid
﻿Required﻿
AN
10
﻿﻿ ID	
IONPAYTEST
merchantToken
﻿Required﻿
AN
64
﻿﻿ Token
b63d66156715bf8c9d851e76
e61a42ce7efb815a91843b75
35c5bcde8490cb4d
recurringToken
﻿Required﻿
AN
64
Recurring Token
75d5220c439b83359ed440ab
12b713ed273feb455cc278fe0
0209e57dfe84c7a
﻿
Response Parameter - Check Recurring Token
Sample Java Response Check Recurring Token
String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String recurringToken = nicePay.Get("recurringToken");
String billingNm= nicePay.Get("billingNm");
String billingEmail = nicePay.Get("billingEmail");
String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String recurringToken = nicePay.Get("recurringToken");
String billingNm= nicePay.Get("billingNm");
String billingEmail = nicePay.Get("billingEmail");
﻿
Parameter
Type
Size
Description
Example / Notes
resultCode
﻿Required﻿
N
4
﻿Result Code﻿﻿
0000
resultMsg
﻿Required﻿
AN
255
Result Message
SUCCESS
transDt
﻿Required﻿
N
8
Transaction Date
20180604
transTm
﻿Required﻿
N
6
Transaction Time
141806
When Success
recurringToken
﻿Required﻿
AN
60
Authorization Number
75d5220c439b83359ed440ab
12b713ed273feb455cc278fe0
0209e57dfe84cjk
When Success
billingEmail
﻿Required﻿
AN
40
Billing Email
﻿
When Success
billingNm
﻿Required﻿
A
30
Billing Name
﻿
When Success
﻿
Remove Recurring Token
API Specification - Remove Recurring Token
API Endpoint
/nicepay/api/removeToken.do
Method
﻿application/x-www-form-urlencoded﻿
﻿POST﻿
Merchant Token
SHA256(Merchant ID + Recurring Token + MerchantKey)
Deskripsi
To remove ﻿ Recurring Token on ﻿ ﻿﻿
﻿
Request Parameter - Remove Recurring Token
Sample Java Request Remove Recurring Token
// Request Mandatory Field
nicePay.setImid("IONPAYTEST");
nicePay.setRecurringToken("f46225e4bb06745ef2e238ddb65ceab1ba4556578bf3b3452964e488f0c8ec36");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getRecurringToken()));

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");

// Request Mandatory Field
nicePay.setImid("IONPAYTEST");
nicePay.setRecurringToken("f46225e4bb06745ef2e238ddb65ceab1ba4556578bf3b3452964e488f0c8ec36");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getRecurringToken()));

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
﻿
Parameter
Type
Size
Description
Example / Notes
iMid
﻿Required﻿
AN
10
﻿﻿ ID	
IONPAYTEST
merchantToken
﻿Required﻿
AN
64
﻿﻿ Token
b63d66156715bf8c9d851e76
e61a42ce7efb815a91843b75
35c5bcde8490cb4d
recurringToken
﻿Required﻿
AN
64
Recurring Token
75d5220c439b83359ed440ab
12b713ed273feb455cc278fe0
0209e57dfe84c7a
﻿
Response Parameter - Remove Recurring Token
Sample Java Response Remove Recurring Token
String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
String resultCd = nicePay.Get("resultCode");
String resultMsg = nicePay.Get("resultMsg");
String transDt = nicePay.Get("transDt");
String transTm = nicePay.Get("transTm");
﻿
Parameter
Type
Size
Description
Example / Notes
resultCode
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
Result Message
SUCCESS
transDt
N
8
Transaction Date
20180604
When Success
transTm
N
6
Transaction Time
141806
When Success
﻿
Credit Card Pre-Auth
﻿
To do Pre-Auth & Capture ﻿, ﻿ ﻿ need preauthToken to ﻿ ﻿ capture ﻿. That ﻿ only can ﻿ during ﻿ preauthToken validity period. Following are ﻿ ﻿ steps on ﻿ ﻿ using Pre-Auth Token.
The ﻿ will input ﻿ data card such as cardNo and ExyMmYy through ﻿ Request Token (onePassToken.do).
The ﻿ will get cardToken.
The Pre-Auth ﻿ on V1 Enterprise divides into 2 ﻿es, Direct 3Ds, and Direct Non-3Ds.
If going through ﻿ 3Ds ﻿, then ﻿ card data will go through ﻿ security verification from ﻿ 3Ds Request (secureVeRequest.do) with an OTP also FDS (Fraud Detection System) ﻿ security.
If not go through ﻿ 3Ds ﻿, then will not go through ﻿ security verification. 
The ﻿ does a ﻿ with ﻿ ﻿ ﻿ (onePass.do). 
The ﻿ does hold ﻿ and gets preauthToken to ﻿ with ﻿ ﻿.
The capture amount ﻿ will use ﻿ Pre-Auth (captureTrans.do) by input preauthToken and CVV.
If preauthToken expired, then ﻿ will become void and ﻿ balance will refund to ﻿ ﻿.
API Specification- Pre-Auth
API Endpoint
/nicepay/api/captureTrans.do
Method
﻿application/x-www-form-urlencoded﻿
﻿POST﻿
Merchant Token
SHA256(Merchant ID + Reference Number + Amount + MerchantKey)
Deskripsi
﻿﻿ ﻿ for ﻿ Pre-Auth using preauthToken
﻿
Request Parameter - Pre-Auth
Sample Request Pre-Auth
Sample Java Request Pre-Auth
// Payment Mandatory Field
nicePay.setPayMethod("01");
nicePay.setCurrency("IDR");
nicePay.setAmt("10000");
nicePay.setInstmntMon("1");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setGoodsNm("Merchant Goods 1");
nicePay.setBillingNm("John Doe");
nicePay.setBillingEmail("john.doe@example.com");
nicePay.setBillingPhone("08123456789");
nicePay.setBillingAddr("Jln. Raya Kasablanka Kav.88");
nicePay.setBillingCity("South Jakarta");
nicePay.setBillingState("DKI Jakarta");
nicePay.setBillingPostCd("10200");
nicePay.setBillingCountry("Indonesia");
nicePay.setDeliveryNm("Merchant's Name");
nicePay.setDeliveryPhone("08123456789");
nicePay.setDeliveryAddr("Jln.Dr. Saharjo No.88");
nicePay.setDeliveryCity("South Jakarta");
nicePay.setDeliveryState("DKI Jakarta");
nicePay.setDeliveryPostCd("10201");
nicePay.setDeliveryCountry("Indonesia");
nicePay.setCallBackUrl(merchantDomain + "callback");
nicePay.setDbProcessUrl(merchantDomain + "dbprocess");
nicePay.setVat("0");
nicePay.setFee("0");
nicePay.setNotaxAmt("0");
nicePay.setDescription("This Is The Description Of The Payment");
nicePay.setUserIP("127.0.0.1");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getReferenceNo()));
nicePay.setCartData("{}");
nicePay.setInstmntMon("1");
nicePay.setInstmntType("1");
nicePay.setCardCvv("100");
nicePay.setPreAuthToken("c2921cc7a1967f905fd4f895f22f06c02d24adf8c9f7b169d6ef0c2c0b128549");
nicePay.setCardExpYymm("3901")

// Payment Optional Field
nicePay.setReqDt("20230516");
nicePay.setReqTm("135959");
nicePay.setReqDomain("merchant.com");
nicePay.setReqServerIP("127.0.0.1");
nicePay.setReqClientVer("1.0");
nicePay.setUserSessionID("userSessionID");
nicePay.setUserAgent("Mozilla");
nicePay.setUserLanguage("en-US");
nicePay.setMerFixAcctId("00000001");
nicePay.setPaymentExpiryDt("20230531");
nicePay.setPaymentExpiryTm("235959");

// Payment Request
nicePay.payment();

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String ccTransType = nicePay.Get("ccTransType");
String fee = nicePay.Get("fee");
String tXid = nicePay.Get("tXid");
String description = nicePay.Get("description");
String notaxAmt = nicePay.Get("notaxAmt");
String cardNo = nicePay.Get("cardNo");
String issuBankCd = nicePay.Get("issuBankCd");
String cardExpYymm = nicePay.Get("cardExpYymm");
String acquBankNm = nicePay.Get("acquBankNm");
String payMethod = nicePay.Get("payMethod");
String callbackUrl = nicePay.Get("callbackUrl");
String instmntMon = nicePay.Get("instmntMon");
String currency = nicePay.Get("currency");
String issuBankNm = nicePay.Get("issuBankNm");
String resultCd = nicePay.Get("resultCd");
String amount = nicePay.Get("amount");
String goodsNm = nicePay.Get("goodsNm");
String referenceNo = nicePay.Get("referenceNo");
String transTm = nicePay.Get("transTm");
String authNo = nicePay.Get("authNo");
String recurringToken = nicePay.Get("recurringToken"); //Only For Recurring
String preauthToken = nicePay.Get("preauthToken"); //Only For Pre-Auth
String vat = nicePay.Get("vat");
String instmntType = nicePay.Get("instmtnType");
String resultMsg = nicePay.Get("resultMsg");
String billingNm = nicePay.Get("billingNm");
String acquBankCd = nicePay.Get("acquBankCd");
String transDt = nicePay.Get("transDt");
// Payment Mandatory Field
nicePay.setPayMethod("01");
nicePay.setCurrency("IDR");
nicePay.setAmt("10000");
nicePay.setInstmntMon("1");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setGoodsNm("Merchant Goods 1");
nicePay.setBillingNm("John Doe");
nicePay.setBillingEmail("john.doe@example.com");
nicePay.setBillingPhone("08123456789");
nicePay.setBillingAddr("Jln. Raya Kasablanka Kav.88");
nicePay.setBillingCity("South Jakarta");
nicePay.setBillingState("DKI Jakarta");
nicePay.setBillingPostCd("10200");
nicePay.setBillingCountry("Indonesia");
nicePay.setDeliveryNm("Merchant's Name");
nicePay.setDeliveryPhone("08123456789");
nicePay.setDeliveryAddr("Jln.Dr. Saharjo No.88");
nicePay.setDeliveryCity("South Jakarta");
nicePay.setDeliveryState("DKI Jakarta");
nicePay.setDeliveryPostCd("10201");
nicePay.setDeliveryCountry("Indonesia");
nicePay.setCallBackUrl(merchantDomain + "callback");
nicePay.setDbProcessUrl(merchantDomain + "dbprocess");
nicePay.setVat("0");
nicePay.setFee("0");
nicePay.setNotaxAmt("0");
nicePay.setDescription("This Is The Description Of The Payment");
nicePay.setUserIP("127.0.0.1");
nicePay.setMerchantToken(nicePay.makeToken(nicePay.getAmt(), nicePay.getReferenceNo()));
nicePay.setCartData("{}");
nicePay.setInstmntMon("1");
nicePay.setInstmntType("1");
nicePay.setCardCvv("100");
nicePay.setPreAuthToken("c2921cc7a1967f905fd4f895f22f06c02d24adf8c9f7b169d6ef0c2c0b128549");
nicePay.setCardExpYymm("3901")

// Payment Optional Field
nicePay.setReqDt("20230516");
nicePay.setReqTm("135959");
nicePay.setReqDomain("merchant.com");
nicePay.setReqServerIP("127.0.0.1");
nicePay.setReqClientVer("1.0");
nicePay.setUserSessionID("userSessionID");
nicePay.setUserAgent("Mozilla");
nicePay.setUserLanguage("en-US");
nicePay.setMerFixAcctId("00000001");
nicePay.setPaymentExpiryDt("20230531");
nicePay.setPaymentExpiryTm("235959");

// Payment Request
nicePay.payment();

// Payment Response
System.out.println("Response String : " + nicePay.getResponseString()); // JSON in String format

String ccTransType = nicePay.Get("ccTransType");
String fee = nicePay.Get("fee");
String tXid = nicePay.Get("tXid");
String description = nicePay.Get("description");
String notaxAmt = nicePay.Get("notaxAmt");
String cardNo = nicePay.Get("cardNo");
String issuBankCd = nicePay.Get("issuBankCd");
String cardExpYymm = nicePay.Get("cardExpYymm");
String acquBankNm = nicePay.Get("acquBankNm");
String payMethod = nicePay.Get("payMethod");
String callbackUrl = nicePay.Get("callbackUrl");
String instmntMon = nicePay.Get("instmntMon");
String currency = nicePay.Get("currency");
String issuBankNm = nicePay.Get("issuBankNm");
String resultCd = nicePay.Get("resultCd");
String amount = nicePay.Get("amount");
String goodsNm = nicePay.Get("goodsNm");
String referenceNo = nicePay.Get("referenceNo");
String transTm = nicePay.Get("transTm");
String authNo = nicePay.Get("authNo");
String recurringToken = nicePay.Get("recurringToken"); //Only For Recurring
String preauthToken = nicePay.Get("preauthToken"); //Only For Pre-Auth
String vat = nicePay.Get("vat");
String instmntType = nicePay.Get("instmtnType");
String resultMsg = nicePay.Get("resultMsg");
String billingNm = nicePay.Get("billingNm");
String acquBankCd = nicePay.Get("acquBankCd");
String transDt = nicePay.Get("transDt");
﻿
Parameter
Type
Size
Description
Example / Notes
iMid
﻿Required﻿
AN
2
﻿﻿ ID	
IONPAYTEST
payMethod
Required﻿
N
2
﻿Payment Method﻿﻿
01
currency
Required
﻿
A
40
Currency
IDR
amt
Required
﻿
N
12
Goods Amount
10000
referenceNo
Required﻿
ANS
40
﻿﻿ Order Number
MerchantReferenceNumber001
goodsNm
Required
﻿
AN
100
Goods Name	
﻿﻿ Goods 1
billingNm
Required
﻿
A
30
Billing Name
John Doe
billingPhone
Required
﻿
N
15
Billing Phone Number	
08123456789
billingEmail
Required﻿
ANS
40
Billing E-Mail	
john.doe@example.com
billingCity
Required﻿
N
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	
﻿﻿﻿
callBackUrl
Required
﻿
ANS
255
﻿﻿ Result Forward URL (On Browser)	
https://www.mechant.com/callbackUrl
dbProcessUrl
Required﻿
ANS
255
﻿﻿ Result Receive URL (Server Side)	
https://www.merchant.com/dbProcessUrl
description
Required﻿
AN
100
Description
This Is The Description Of The ﻿﻿
merchantToken
Required
﻿
AN
255
﻿﻿ Token	
2349fcbd3a5b81d08ca719cc6d9c826f2f6f9d4de337b86e4019114aad6222b1
userIP
Required﻿
ANS
15
User IP	
127.0.0.1
cartData
Required
﻿
ANS
4000
Cart Data (JSON Format)	
{}
instmntType
Required
﻿
N
2
﻿Installment Type﻿﻿
1
instmntMon
Required
﻿
N
2
Installment Month	
1
cardCvv
N
3
Card CVV	
100
preauthToken
﻿Required
﻿
AN
255
Pre-Auth Token
c2921cc7a1967f905fd4f895f22f06c02d24adf8c9f7b169d6ef0c2c0b128549
recurrOpt
Required For Recurring CC
﻿
N
2
0 : Automatic Cancel
1 : Do Not Cancel
2 : Do Not Make Token
1
billingAddr
AN
255
Billing Address	
Jln. Raya Kasablanka Kav.88
deliveryNm
A
30
Delivery Name	
﻿﻿'s Name
deliveryPhone
N
15
Delivery Phone	
08123456789
deliveryAddr
AN
100
Delivery Address	
Jln. Dr. Saharjo No.88
deliveryEmail
AN
100
Delivery E-Mail	
example@merchant.com
deliveryCity
A
50
Delivery City	
South Jakarta
deliveryState
A
50
Delivery State	
DKI Jakarta
deliveryPostCd
N
10
Delivery Post Number	
10201
deliveryCountry
A
A
Delivery Country	
﻿﻿﻿
vat
N
12
﻿﻿ 
0
fee
N
12
Service Tax	
0
notaxAmt
N
12
Tax Free Amount	
0
reqDt
N
N
Request Date (YYYYMMDD)	
20230516
reqTm
N
N
Request Time (HH24MISS)	
135959
reqDomain
ANS
100
Request Domain	
www.merchant.com
reqServerIP
ANS
15
Request Server IP	
127.0.0.1
reqClientVer
ANS
50
Request Client Version	
1.0
userSessionID
AN
100
User Session ID
userSessionID
userAgent
ANS
100
User Agent Information
Mozilla
userLanguage
ANS
2
User Language
en-US
﻿
Response Parameter - Pre-Auth
Sample Response Pre-Auth
{
    "issuBankNm": "BCA",
    "resultCd": "0000",
    "amount": "1000",
    "ccTransType": "4",
    "authNo": "051837",
    "referenceNo": "MerchantReferenceNumber001",
    "transTm": "234619",
    "fee": null,
    "vat": null,
    "tXid": "IONPAYTEST01202305212346199270",
    "description": "This Is The Description Of The Payment",
    "notaxAmt": null,
    "cardNo": "51234500****0008",
    "issuBankCd": "CENA",
    "instmntType": "1",
    "resultMsg": "SUCCESS",
    "acquBankCd": "BNIA",
    "cardExpYymm": "3901",
    "acquBankNm": "CIMB",
    "payMethod": "01",
    "callbackUrl": "https://www.merchant.com/callbackUrl",
    "instmntMon": "1",
    "transDt": "20230516"
}
{
    "issuBankNm": "BCA",
    "resultCd": "0000",
    "amount": "1000",
    "ccTransType": "4",
    "authNo": "051837",
    "referenceNo": "MerchantReferenceNumber001",
    "transTm": "234619",
    "fee": null,
    "vat": null,
    "tXid": "IONPAYTEST01202305212346199270",
    "description": "This Is The Description Of The Payment",
    "notaxAmt": null,
    "cardNo": "51234500****0008",
    "issuBankCd": "CENA",
    "instmntType": "1",
    "resultMsg": "SUCCESS",
    "acquBankCd": "BNIA",
    "cardExpYymm": "3901",
    "acquBankNm": "CIMB",
    "payMethod": "01",
    "callbackUrl": "https://www.merchant.com/callbackUrl",
    "instmntMon": "1",
    "transDt": "20230516"
}
﻿
Parameter
Type
Size
Description
resultCd 
N
4
﻿Result Code﻿﻿
resultMsg
AN
255
﻿Result Message﻿﻿
tXid
AN
30
Transaction ID
referenceNo
ANS
40
﻿﻿ Order Number
payMethod
N
2
﻿Payment Method﻿﻿
amount
N
12
Transaction Amount
currency
AN
3
Currency
goodsNm
N
100
Goods Name
billingNm
N
30
Buyer Name
transDt
N
8
Transaction Date (YYYYMMDD)
transTm
N
6
Transaction Time (HH24MISS)
description
AN
100
Transaction Description
callbackUrl
ANS
100
Callback URL
authNo
N
10
Authorization Number
issuBankCd
A
4
﻿Issuing Bank Code﻿﻿
issuBankNm
A
255
Issuing ﻿ Name
acquBankCd
A
4
﻿Acquiring Bank Code﻿﻿
acquBankNm
A
255
Acquiring ﻿ Name
cardNo
ANS
20
Card Number (Masked)
instmntMon
N
2
Installment Month
instmntType
N
2
﻿Installment Type﻿﻿
ccTransType
N
2
﻿Credit Card Transaction Type﻿
vat
N
12
{{vat}} Number
fee
N
12
Service Fee
notaxAmt
N
12
Tax Free Amount

API Endpoint	/nicepay/api/onePassToken.do
Request Method application/x-www-form-urlencoded	POST
Description	Request onePassToken for Transaction.
Merchant Token	SHA256 (iMid+ referenceNo+ amt+ merchantKey)
Payment Methods	01

Parameter	Type	Size	Description	Example Value
iMid Required	AN	10	ID	IONPAYTEST
merchantToken Required	AN	255	Token	f5d1a08fd497bf3f39e9a0027c0a6822109903cd95140c36db537b5977fb9652
cardNo Required	N	16	Card Number	5123450000000008
cardExpYYmm Required	N	4	Card Expiry (YYMM)	3901
cardHolderNm Required	AN	45	Card Holder Name	John Doe Only alphabet allowed
cardHolderEmail Required	ANS	100	Card Holder Email	johndoe@gmail.com
amt Required	N	12	Amount	10000
referenceNo Required	ANS	40	Order Number	MerchantReferenceNumber001
instmntType	N	2	Installment Type	1
instmntMon	N	2	Installment Month	1

Parameter	Type	Size	Description
resultCd	N	4	Result Code
resultMsg	AN	255	Result Message
cardToken	AN	64	One Time Use Transaction Token
paymentType	N	1	CC Authorization Type

paymentType	Description
1	3D Secure
2	KeyIn (Proceed to Registration without 3Ds/MIGS)
3	MiGS

API Endpoint	/nicepay/api/secureVeRequest.do
Method application/x-www-form-urlencoded	Pop Up or Redirect
Description	Request 3D for paymentType = 1
Merchant Token	SHA256 (iMid+ referenceNo+ amt+ merchantKey)

Parameter	Type	Size	Description	Example
country Required	N	3	Country	360
callbackUrl Required	ANS	200	Callback URL	http://merchant.com/callback
onePassToken Required	AN	64	One time use token	c5bd0b91bcc3d21358cd004c60e54 579441c23aa8e7553b41ce3402db1113fff

Parameter	Type	Size	Description
resultCd	N	4	Result Code
resultMsg	AN	255	Result Message
referenceNo	ANS	40	Order Number
merchantToken	AN	255	Token

API url	/nicepay/api/migsRequest.do
Request Method application/x-www-form-urlencoded	POST or Redirect
Description	Request MIGS for paymentType = 3
Merchant Token	SHA256 (iMid+ referenceNo+ amt+ merchantKey)
Payment Methods	01

Parameter	Type	Size	Description	Example
instmntType Required	N	2	Installment Type	1
instmntMon	N	2	Installment Month	1
referenceNo Required	ANS	40	Order Number	MerchantReferenceNumber001
cardCvv	N	3	Card CVV	100
callbackUrl Required	ANS	200	Callback URL for result	http://merchant.com/callbackUrl
onePassToken Required	AN	64	One Time Use Transaction Token	d12b153b3dd50b1875e64ac17288a7cd33fd5511cf01924cac2ca7f345de8f08

Parameter	Type	Size	Description
resultCd	N	4	Result Code
resultMsg	AN	255	Result Message

API Endpoint	/nicepay/api/onePass.do
Request Method application/x-www-form-urlencoded	POST
Description	Register Transaction and Charge using onePassToken
Merchant Token	SHA256 (iMid+ referenceNo+ amt+ merchantKey)
Payment Methods	01

Parameter	Type	Size	Description	Example / Notes
iMid Required	AN	2	ID	IONPAYTEST
payMethod Required	N	2	Payment Method	01
currency Required	A	40	Currency	IDR
amt Required	N	12	Goods Amount	10000
referenceNo Required	ANS	40	Order Number	MerchantReferenceNumber001
goodsNm Required	AN	100	Goods Name	Goods 1
billingNm Required	A	30	Billing Name	John Doe
billingPhone Required	N	15	Billing Phone Number	08123456789
billingEmail Required	ANS	40	Billing E-Mail	john.doe@example.com
billingCity Required	N	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
callBackUrl Required	ANS	255	Result Forward URL (On Browser)	https://www.mechant.com/callbackUrl
dbProcessUrl Required	ANS	255	Result Receive URL (Server Side)	https://www.merchant.com/dbProcessUrl
description Required	AN	100	Description	This Is The Description Of The
merchantToken Required	AN	255	Token	2349fcbd3a5b81d08ca719cc6d9c826f2f6f9d4de337b86e4019114aad6222b1
userIP Required	ANS	15	User IP	127.0.0.1
cartData Required	ANS	4000	Cart Data (JSON Format)	{}
instmntType Required	N	2	Installment Type	1
instmntMon Required	N	2	Installment Month	1
cardCvv	N	3	Card CVV	100
onePassToken Required	AN		One Time Use Transaction Token	9338d54573688ae18e175240b0257de48d89c6ef1c9c7b5c094dc4beed9e435f
recurrOpt Required For Recurring CC	N	2	0 : Automatic Cancel 1 : Do not cancel 2 : Do not make token	1
billingAddr	AN	255	Billing Address	Jln. Raya Kasablanka Kav.88
deliveryNm	A	30	Delivery Name	's Name
deliveryPhone	N	15	Delivery Phone	08123456789
deliveryAddr	AN	100	Delivery Address	Jln. Dr. Saharjo No.88
deliveryEmail	AN	100	Delivery E-Mail	example@merchant.com
deliveryCity	A	50	Delivery City	South Jakarta
deliveryState	A	50	Delivery State	DKI Jakarta
deliveryPostCd	N	10	Delivery Post Number	10201
deliveryCountry	A	A	Delivery Country
vat	N	12		0
fee	N	12	Service Tax	0
notaxAmt	N	12	Tax Free Amount	0
reqDt	N	N	Request Date (YYYYMMDD)	20230516
reqTm	N	N	Request Time (HH24MISS)	135959
reqDomain	ANS	100	Request Domain	www.merchant.com
reqServerIP	ANS	15	Request Server IP	127.0.0.1
reqClientVer	ANS	50	Request Client Version	1.0
userSessionID	AN	100	User Session ID	userSessionID
userAgent	ANS	100	User Agent Information	Mozilla
userLanguage	ANS	2	User Language	en-US

Parameter	Type	Size	Description
resultCd	N	4	Result Code
resultMsg	AN	255	Result Message
tXid	AN	30	Transaction ID
referenceNo	ANS	40	Order Number
payMethod	N	2	Payment Method
amount	N	12	Transaction Amount
currency	AN	3	Currency
goodsNm	N	100	Goods Name
billingNm	N	30	Buyer Name
transDt	N	8	Transaction Date (YYYYMMDD)
transTm	N	6	Transaction Time (HH24MISS)
description	AN	100	Transaction Description
callbackUrl	ANS	100	Callback URL
authNo	N	10	Authorization Number
issuBankCd	A	4	Issuing Bank Code
issuBankNm	A	255	Issuing Name
acquBankCd	A	4	Acquiring Bank Code
acquBankNm	A	255	Acquiring Name
cardNo	ANS	20	Card Number (Masked)
instmntMon	N	2	Installment Month
instmntType	N	2	Installment Type
recurringToken	AN	64	Token for Recurring
preauthToken	AN	64	Token for Preauth
ccTransType	N	2	Credit Card Transaction Type
vat	N	12	Number
fee	N	12	Service Fee
notaxAmt	N	12	Tax Free Amount

API Endpoint	/nicepay/api/recurringToken.do
Request Method application/x-www-form-urlencoded	POST
Description	recurringToken.do almost similar to onePassToken.do difference whether use card info or recurring token
Merchant Token	SHA256 (Merchant ID + Reference Number + Amount + Merchant Key)

Parameter	Type	Size	Description	Example / Notes
amt Required	N	12	Amount	10000
referenceNo Required	AN	40	Order Number	MerchantReferenceNumber001
merchantToken Required	AN	255	Token	baf19eaed10d8539498cbe06ed19c50a60a587416d9c980abbb3c06b4eee51f5
iMid Required	AN	10	ID	IONPAYTEST
recurringToken Required	AN	100	Recurring Token	88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a
instmntType Required	AN	2	Installment Type	1
instmntMon Required	N	2	Installment Month	1
cardHolderNm Required	AN	45	Card Holder Name	John Doe Only alphabet allowed
cardHolderEmail Required	ANS	100	Card Holder Email	johndoe@gmail.com

Parameter	Type	Size	Description	Remark
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message	SUCCESS
cardToken	AN	64	Recurring Token	c954f03ef83a363f94fa26bef6ec4d08fa7693590a735386fcce6e2ef1caae8a
paymentType	AN	1	CC Authorization type 1 : 3Ds 2 : KeyIn

API Endpoint	/nicepay/api/recurringTrans.do
Method application/x-www-form-urlencoded	POST
Merchant Token	SHA256(Merchant ID + Reference Number + Amount + MerchantKey)
Description	The for Recurring or with Recurring Token

Parameter	Type	Size	Description	Example / Notes
iMid Required	AN	2	ID	IONPAYTEST
payMethod Required	N	2	Payment Method	01
currency Required	A	40	Currency	IDR
amt Required	N	12	Goods Amount	10000
referenceNo Required	ANS	40	Order Number	MerchantReferenceNumber001
goodsNm Required	AN	100	Goods Name	Goods 1
billingNm Required	A	30	Billing Name	John Doe
billingPhone Required	N	15	Billing Phone Number	08123456789
billingEmail Required	ANS	40	Billing E-Mail	john.doe@example.com
billingCity Required	N	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
callBackUrl Required	ANS	255	Result Forward URL (On Browser)	https://www.mechant.com/callbackUrl
dbProcessUrl Required	ANS	255	Result Receive URL (Server Side)	https://www.merchant.com/dbProcessUrl
description Required	AN	100	Description	This Is The Description Of The
merchantToken Required	AN	255	Token	2349fcbd3a5b81d08ca719cc6d9c826f2f6f9d4de337b86e4019114aad6222b1
userIP Required	ANS	15	User IP	127.0.0.1
cartData Required	ANS	4000	Cart Data (JSON Format)	{}
instmntType Required	N	2	Installment Type	1
instmntMon Required	N	2	Installment Month	1
cardCvv	N	3	Card CVV	100
recurringToken Required	AN	64	Recurring Token	88cb7e30c531429a95fb2af442f591b75939fd0387288af2dc2340c50776d84a
recurrOpt Required For Recurring CC	N	2	0 Automatic Cancel 1 Do Not Cancel 2 Do Not Make Token	1
billingAddr	AN	255	Billing Address	Jln. Raya Kasablanka Kav.88
deliveryNm	A	30	Delivery Name	's Name
deliveryPhone	N	15	Delivery Phone	08123456789
deliveryAddr	AN	100	Delivery Address	Jln. Dr. Saharjo No.88
deliveryEmail	ANS	100	Delivery E-Mail	example@merchant.com
deliveryCity	A	50	Delivery City	South Jakarta
deliveryState	A	50	Delivery State	DKI Jakarta
deliveryPostCd	N	10	Delivery Post Number	10201
deliveryCountry	A	A	Delivery Country
vat	N	12		0
fee	N	12	Service Tax	0
notaxAmt	N	12	Tax Free Amount	0
reqDt	N	N	Request Date (YYYYMMDD)	20230516
reqTm	N	N	Request Time (HH24MISS)	135959
reqDomain	ANS	100	Request Domain	www.merchant.com
reqServerIP	ANS	15	Request Server IP	127.0.0.1
reqClientVer	ANS	50	Request Client Version	1.0
userSessionID	AN	100	User Session ID	userSessionID
userAgent	ANS	100	User Agent Information	Mozilla
userLanguage	ANS	2	User Language	en-US

Parameter	Type	Size	Description
resultCd	N	4	Result Code
resultMsg	AN	255	Result Message
tXid	AN	30	Transaction ID
referenceNo	ANS	40	Order Number
payMethod	N	2	Payment Method
amount	N	12	Transaction Amount
currency	AN	3	Currency
goodsNm	N	100	Goods Name
billingNm	N	30	Buyer Name
transDt	N	8	Transaction Date (YYYYMMDD)
transTm	N	6	Transaction Time (HH24MISS)
description	AN	100	Transaction Description
callbackUrl	ANS	100	Callback URL
authNo	N	10	Authorization Number
issuBankCd	A	4	Issuing Bank Code
issuBankNm	A	255	Issuing Name
acquBankCd	A	4	Acquiring Bank Code
acquBankNm	A	255	Acquiring Name
cardNo	ANS	20	Card Number (Masked)
instmntMon	N	2	Installment Month
instmntType	N	2	Installment Type
ccTransType	N	2	Transaction Type
vat	N	12	Number
fee	N	12	Service Fee
notaxAmt	N	12	Tax Free Amount

API Endpoint	/nicepay/api/tokenize.do
Method application/x-www-form-urlencoded	POST
Description	To generate 's Recurring Token without through beforehand.
Merchant Token	SHA256 (Merchant ID + Card No + Card Exp Yymm + Merchant Key)

Parameter	Type	Size	Description	Contoh / Catatan
iMid Required	AN	10	ID	IONPAYTEST
merchantToken Required	AN	255	Token	b63d66156715bf8c9d851e76 e61a42ce7efb815a91843b75 35c5bcde8490cb4d
cardNo Required	N	16	Card Number	552103******6573
cardExpYymm Required	N	4	Card Expired YY/MM	2012
billingNm Required	A	30	Billing Name	John Doe
cardHolderNm Required	AN	45	Card Holder Name	John Doe
cardHolderEmail Required	ANS	100	Cardholder Email	johndoe@gmail.com

Parameter	Type	Size	Description	Example / Notes
resultCode	N	4	Result Code	0000
resultMsg	AN	255	Result Message	SUCCESS
transDt	N	8	Transaction Date	20180604 When Success
transTm	N	6	Transaction Time	141806 When Success
recurringToken	AN	10	Recurring Token	75d5220c439b83359ed440ab 12b713ed273feb455cc278fe0 0209e57dfe84cjk When Success

API Endpoint	/nicepay/api/checkToken.do
Method application/x-www-form-urlencoded	POST
Merchant Token	SHA256(Merchant ID + Recurring Token + MerchantKey)
Deskripsi	To check Recurring Token on .

Parameter	Type	Size	Description	Example / Notes
iMid Required	AN	10	ID	IONPAYTEST
merchantToken Required	AN	64	Token	b63d66156715bf8c9d851e76 e61a42ce7efb815a91843b75 35c5bcde8490cb4d
recurringToken Required	AN	64	Recurring Token	75d5220c439b83359ed440ab 12b713ed273feb455cc278fe0 0209e57dfe84c7a

Parameter	Type	Size	Description	Example / Notes
resultCode Required	N	4	Result Code	0000
resultMsg Required	AN	255	Result Message	SUCCESS
transDt Required	N	8	Transaction Date	20180604
transTm Required	N	6	Transaction Time	141806 When Success
recurringToken Required	AN	60	Authorization Number	75d5220c439b83359ed440ab 12b713ed273feb455cc278fe0 0209e57dfe84cjk When Success
billingEmail Required	AN	40	Billing Email	When Success
billingNm Required	A	30	Billing Name	When Success

API Endpoint	/nicepay/api/removeToken.do
Method application/x-www-form-urlencoded	POST
Merchant Token	SHA256(Merchant ID + Recurring Token + MerchantKey)
Deskripsi	To remove Recurring Token on

Parameter	Type	Size	Description	Example / Notes
iMid Required	AN	10	ID	IONPAYTEST
merchantToken Required	AN	64	Token	b63d66156715bf8c9d851e76 e61a42ce7efb815a91843b75 35c5bcde8490cb4d
recurringToken Required	AN	64	Recurring Token	75d5220c439b83359ed440ab 12b713ed273feb455cc278fe0 0209e57dfe84c7a

Parameter	Type	Size	Description	Example / Notes
resultCode	N	4	Result Code	0000
resultMsg	AN	255	Result Message	SUCCESS
transDt	N	8	Transaction Date	20180604 When Success
transTm	N	6	Transaction Time	141806 When Success

API Endpoint	/nicepay/api/captureTrans.do
Method application/x-www-form-urlencoded	POST
Merchant Token	SHA256(Merchant ID + Reference Number + Amount + MerchantKey)
Deskripsi	for Pre-Auth using preauthToken

Parameter	Type	Size	Description	Example / Notes
iMid Required	AN	2	ID	IONPAYTEST
payMethod Required	N	2	Payment Method	01
currency Required	A	40	Currency	IDR
amt Required	N	12	Goods Amount	10000
referenceNo Required	ANS	40	Order Number	MerchantReferenceNumber001
goodsNm Required	AN	100	Goods Name	Goods 1
billingNm Required	A	30	Billing Name	John Doe
billingPhone Required	N	15	Billing Phone Number	08123456789
billingEmail Required	ANS	40	Billing E-Mail	john.doe@example.com
billingCity Required	N	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
callBackUrl Required	ANS	255	Result Forward URL (On Browser)	https://www.mechant.com/callbackUrl
dbProcessUrl Required	ANS	255	Result Receive URL (Server Side)	https://www.merchant.com/dbProcessUrl
description Required	AN	100	Description	This Is The Description Of The
merchantToken Required	AN	255	Token	2349fcbd3a5b81d08ca719cc6d9c826f2f6f9d4de337b86e4019114aad6222b1
userIP Required	ANS	15	User IP	127.0.0.1
cartData Required	ANS	4000	Cart Data (JSON Format)	{}
instmntType Required	N	2	Installment Type	1
instmntMon Required	N	2	Installment Month	1
cardCvv	N	3	Card CVV	100
preauthToken Required	AN	255	Pre-Auth Token	c2921cc7a1967f905fd4f895f22f06c02d24adf8c9f7b169d6ef0c2c0b128549
recurrOpt Required For Recurring CC	N	2	0 : Automatic Cancel 1 : Do Not Cancel 2 : Do Not Make Token	1
billingAddr	AN	255	Billing Address	Jln. Raya Kasablanka Kav.88
deliveryNm	A	30	Delivery Name	's Name
deliveryPhone	N	15	Delivery Phone	08123456789
deliveryAddr	AN	100	Delivery Address	Jln. Dr. Saharjo No.88
deliveryEmail	AN	100	Delivery E-Mail	example@merchant.com
deliveryCity	A	50	Delivery City	South Jakarta
deliveryState	A	50	Delivery State	DKI Jakarta
deliveryPostCd	N	10	Delivery Post Number	10201
deliveryCountry	A	A	Delivery Country
vat	N	12		0
fee	N	12	Service Tax	0
notaxAmt	N	12	Tax Free Amount	0
reqDt	N	N	Request Date (YYYYMMDD)	20230516
reqTm	N	N	Request Time (HH24MISS)	135959
reqDomain	ANS	100	Request Domain	www.merchant.com
reqServerIP	ANS	15	Request Server IP	127.0.0.1
reqClientVer	ANS	50	Request Client Version	1.0
userSessionID	AN	100	User Session ID	userSessionID
userAgent	ANS	100	User Agent Information	Mozilla
userLanguage	ANS	2	User Language	en-US

Parameter	Type	Size	Description
resultCd	N	4	Result Code
resultMsg	AN	255	Result Message
tXid	AN	30	Transaction ID
referenceNo	ANS	40	Order Number
payMethod	N	2	Payment Method
amount	N	12	Transaction Amount
currency	AN	3	Currency
goodsNm	N	100	Goods Name
billingNm	N	30	Buyer Name
transDt	N	8	Transaction Date (YYYYMMDD)
transTm	N	6	Transaction Time (HH24MISS)
description	AN	100	Transaction Description
callbackUrl	ANS	100	Callback URL
authNo	N	10	Authorization Number
issuBankCd	A	4	Issuing Bank Code
issuBankNm	A	255	Issuing Name
acquBankCd	A	4	Acquiring Bank Code
acquBankNm	A	255	Acquiring Name
cardNo	ANS	20	Card Number (Masked)
instmntMon	N	2	Installment Month
instmntType	N	2	Installment Type
ccTransType	N	2	Credit Card Transaction Type
vat	N	12	{{vat}} Number
fee	N	12	Service Fee
notaxAmt	N	12	Tax Free Amount

V1 Enterprise

Virtual Account - V1 Enterprise

Credit Card - V1 Enterprise

Credit Card

Credit Card Flow V1 Enterprise

Request Token

API Specifications - Request Token

Request Parameter - Request Token

Response Parameter - Request Token

3Ds Request

API Specification - 3Ds

Request Parameter - 3Ds

Response Parameter - 3Ds

MiGS Request

API Specifications - MiGS

Request Parameter - MiGS

Response Parameter - MiGS

Credit Card Payment

API Specifications - Credit Card Payment

Request Parameter - Credit Card Registration

Response Parameter - Credit Card Payment

Credit Card Recurring

Recurring Issue

API Specification - Recurring Issue

Request Parameter - Recurring Issue

Response Parameter - Recurring Issue

Recurring Payment

API Specifications - Recurring Payment

Request Parameter- Recurring Payment

Response Parameter - Recurring Payment

Generate Recurring Token Without First Payment

API Specification - Generate Recurring Token Without First Payment

Request Parameter - Generate Recurring Token

Response Parameter - Generate Recurring Token

Check Recurring Token

API Specification - Check Recurring Token

Request Parameter - Check Recurring Token

Response Parameter - Check Recurring Token

Remove Recurring Token

API Specification - Remove Recurring Token

Request Parameter - Remove Recurring Token

Response Parameter - Remove Recurring Token

Credit Card Pre-Auth

API Specification- Pre-Auth

Request Parameter - Pre-Auth

Response Parameter - Pre-Auth

Welcome to NICEPAY DOCS