NICEPAY API
...
API Versi 1
V1 Enterprise

Credit Card - V1 Enterprise

56min

Credit Card



Langkah-langkah :

  1. Request onePassToken.
  2. Redirect untuk  3Ds / MiGS.
  3.  memasukkan OTP pada  3Ds.
  4.  mendaftarkan  .
  5.  mengirimkan .
Alur Kartu Kredit V1 Enterprise
Alur Kartu Kredit V1 Enterprise


Alur :

  1.  melakukan checkout.
  2.  mengajukan checkout kepada .
  3.  mendaftarkan data checkout.
  4.  mengirimkan response berupa formulir data kartu kepada .
  5.  memasukkan data kartu.
  6.  mengirimkan  data kartu kepada .
  7.  mengirimkan request menggunakan  Regist kepada .
  8.  menyimpan data pesanan.
  9.  mengirimkan response kepada .
  10.  mengajukan  menggunakan   kepada .
  11.  mengajukan 3Ds kepada .
  12.  melakukan verifikasi pengajuan.
  13.  mengirimkan response 3Ds Url kepada .
  14.  mengirimkan  autentikasi 3Ds kepada .
  15.  mengirimkan OTP kepada .
  16.  memasukkan OTP dan mengirim data tersebut kepada .
  17.  melakukan validasi OTP.
  18.  mengirimkan hasil 3Ds kepada .
  19.  melakukan kalkulasi FDS.
  20.  mengajukan  kepada .
  21.  melakukan  .
  22.  mengirimkan response  kepada .
  23.  mengirimkan   menggunakan callBackUrl dan dbProcessUrl kepada .
  24.  menerima .
  25.  mengajukan pemeriksaan  kepada .
  26.  mengirimkan response hasil pemeriksaan  kepada .
  27.  menerima  terakhir.
  28.  mengirimkan hasil pesanan kepada .



Request Token



 wajib melakukan request onePassToken untuk setiap  Credit Card menggunakan  V1 Enterprise.

API Specifications - Request Token

API Endpoint

/nicepay/api/onePassToken.do

Method

application/x-www-form-urlencoded

POST

Description

Request onePassToken for  Transaction.

Merchant Token

SHA256 (iMid+ referenceNo+ amt+ merchantKey)



Request Parameter - Request Token

Parameter di bawah ini harus dikirim dalam  'jsonData' dan dengan format JSON.

Token Request


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

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

1

instmntMon

N

2

Installment Month

1



Response Parameter - Request Token

Sample Response Token


Parameter

Tipe

Ukuran

Deskripsi

resultCd

N

4

Result Code

resultMsg

AN

255

cardToken

AN

64

One Time Use Transaction Token

paymentType

N

1

CC Authorization type

Mohon untuk memperhatikan  paymentType dari response onePassToken.do. Ini akan diperlukan tahap selanjutnya untuk menentukan menggunakan 3Ds atau MiGS.

paymentType

Deskripsi

1

3D Secure

2

KeyIn (Proceed to Registration without 3Ds / MiGS)

3

MiGS



3Ds Request



Gunakan  ini jika mendapatkan paymentType = 1 dari response onePassToken.do.

Langkah-langkah 3Ds:

  1. Kirim Request Parameter ke 3Ds Request .
  2. Pembeli akan redirect ke  3Ds.
  3. Pembeli input OTP.
  4.  akan mengirimkan Response Parameter ke callbackUrl.



API Specifications - 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

Sample Request 3Ds


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

country

Required

N

3

Country

360

callbackUrl

Required

ANS

200

Callback URL

https://merchant.com/callback

onePassToken Required

AN

64

One Time Use Transaction Token

d12b153b3dd50b1875e64ac17288a7cd33fd5511cf01924cac2ca7f345de8f08



Response Parameter - 3Ds

Sample Response 3Ds


Parameter

Tipe

Ukuran

Deskripsi

resultCd

N

4

Result Code

resultMsg

AN

255

referenceNo

ANS

40

 Order Number

merchantToken

AN

255

 Token



MiGS Request



MiGS (Mastercard Internet Gateway Service) adalah sebuah  dari Mastercard untuk melakukan pengembalian dana dan memantau laporan  berdasarkan  antara  dan .

Saat ini,  menggunakan MPGS (Mastercard Payment Gateway Service)  merupakan versi terbaru dari MiGS untuk meningkatkan keamanan  dengan fitur 3Ds 2.0. Meskipun demikian,  MiGS masih dapat digunakan dalam  MPGS.

Gunakan  ini jika mendapatkan paymentType = 3 dari response onePassToken.do.

Langkah-langkah:

  1. Kirim Request Parameter ke MiGS Request .
  2. Pembeli akan redirect ke  MiGS.
  3. Pembeli input OTP.
  4.  akan mengirimkan Response Parameter ke callbackUrl.



API Specifications - MiGS

API Endpoint

/nicepay/api/migsRequest.do

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 Request MiGS


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

instmntType

Required

N

2

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 Response MiGS


Parameter

Tipe

Ukuran

Deskripsi

resultCd

N

4

Result Code

resultMsg

AN

255



Credit Card Payment



API Specifications - Credit Card Payment

API Endpoint

/nicepay/api/onePass.do

Method

application/x-www-form-urlencoded

POST

Description

Mendaftarkan Transaksi dan melakukan Charge  menggunakan onePassToken

Merchant Token

SHA256 (iMid+ referenceNo+ amt+ merchantKey)

Payment Methods

01 



Request Parameter - Credit Card Payment

Sample Request Payment
Sample Java Request Credit Card


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

2

 ID

IONPAYTEST

payMethod Required

N

2

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

1

instmntMon Required 

N

2

Installment Month

1

cardCvv

N

3

Card CVV

100

onePassToken Required 

AN

64

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

100

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 Response Payment


Parameter

Tipe

Ukuran

Deskripsi

resultCd

N

4

Result Code

resultMsg

AN

255

tXid

AN

30

Transaction ID

referenceNo

ANS

40

 Order Number

payMethod

N

2

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

issuBankNm

A

255

Issuing  Name

acquBankCd

A

4

acquBankNm

A

255

Acquiring  Name

cardNo

ANS

20

Card Number with Masking

instmntMon

N

2

Installment Month

instmntType

N

2

recurringToken

AN

64

Token for Recurring 

preauthToken

AN

64

Token for Pre-Auth 

ccTransType

N

2

vat

N

12

 Number

fee

N

12

Service Fee

notaxAmt

N

12

Tax Free Amount



Credit Card Recurring



Saat  menandatangani kontrak sebagai Recurring,  memberikan RecurringToken ke response  Pembayaran.  dapat menggunakan RecurringToken untuk permintaan  Pembayaran berikutnya tanpa memasukan detail kartu, kecuali CVV (Mandatory).



Recurring Issue

Untuk melakukan pembayaran Recurring,  membutuhkan recurringToken milik  agar dapat menggunakan   secara berkala tanpa harus memasukkan data kartu berkali-kali. recurringToken didapatkan setelah  melakukan  untuk pertama kali. Berikut adalah langkah untuk mendapatkan recurringToken.

  1.  akan memasukkan data kartu berupa cardNo dan ExyMmYy melalui  Request Token (onePassToken.do).
  2.  akan mendapatkan cardToken.
  3. Proses  dengan Recurring pada V1 Enterprise terbagi menjadi 2, yaitu Direct 3Ds dan Direct Non-3Ds.
    • Jika melalui  3Ds, maka data kartu akan melalui verifikasi keamanan dari  3Ds Request (secureVeRequest.do) berupa OTP serta keamanan FDS (Fraud Detection System) .
    • Jika tidak melalui  3Ds, maka tidak akan melalui verifikasi keamanan.
  4.  melakukan  dengan    (onePass.do) dan mendapatkan recurringToken untuk melakukan  dengan secara berkala.

API Specification - Recurring Issue

API Endpoint

/nicepay/api/recurringToken.do

Method 

application/x-www-form-urlencoded

POST

Description

recurringToken.do hampir sama dengan onePassToken.do bedanya apakah menggunakan info kartu atau Recurring Token

Merchant Token

SHA256 (Merchant ID + Reference Number + Amount + Merchant Key)



Request Parameter - Recurring Issue

Parameter di bawah ini harus dikirim dalam  'jsonData' dan dengan format JSON.

Sample Request Recurring Issue


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

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

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


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCd

N

4

Result Code

0000

resultMsg

AN

255

SUCCESS

cardToken

AN

64

Recurring Token

9338d54573688ae18e175240b0257de48d89c6ef1c9c7b5c094dc4beed9e435f

paymentType

AN

1

1 : 3Ds

2 : KeyIn





Recurring Payment

Setelah mendapatkan recurringToken dari  pertama yang berhasil atau hasil  pendaftaran kartu,  akan menggunakan recurringToken tersebut untuk melakukan  pada jadwal berikutnya. Berikut adalah langkah  pada  dalam menggunakan recurringToken.

  1.  recurringToken  didapatkan dari   pertama (onePass.do) atau hasil  pendaftaran kartu (tokenize.do).
  2. Kemudian, cardToken akan didapatkan dan disimpan pada database untuk digunakan pada  selanjutnya.
  3. Khusus  3Ds, data kartu akan melalui verifikasi keamanan dari  3Ds Request (secureVeRequest.do) berupa OTP serta keamanan FDS (Fraud Detection System)  dengan menggunakan cardToken  didapatkan dari langkah sebelumnya.
  4. Pembayaran akan dilakukan menggunakan  Recurring  (recurringTrans.do).

Proses ini akan terus berjalan selama masa Recurring berlaku.

Pada  recurring berikutnya, recurringToken  akan digunakan berasal dari recurringToken.do . onePass.do hanya digunakan pada saat  recurring pertama kali.

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)

Deskripsi

 Pembayaran untuk  Recurring atau  menggunakan Recurring Token



Request Parameter - Recurring Payment

Sample Request Recurring Payment
Sample Java Request Recurring Paymen


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

2

 ID

IONPAYTEST

payMethod Required

N

2

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

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

Vat

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


Parameter

Tipe

Ukuran

Deskripsi

resultCd

N

4

Result Code

resultMsg

AN

255

tXid

AN

30

Transaction ID

referenceNo

ANS

40

 Order Number

payMethod

N

2

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

issuBankNm

A

255

Issuing  Name

acquBankCd

A

4

acquBankNm

A

255

Acquiring  Name

cardNo

ANS

20

Card Number with Masking

instmntMon

N

2

Installment Month

instmntType

N

2

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

 ini digunakan khusus pada  tipe Recurring untuk membuat recurringToken tanpa melakukan    terlebih dahulu, melainkan hanya melalui  pendaftaran  kartu. recurringToken  berhasil dibuat dapat digunakan untuk melakukan   (recurringTrans.do).

API Specification - Generate Recurring Token Without First Payment

API Endpoint

/nicepay/api/tokenize.do

Method 

application/x-www-form-urlencoded

POST

Description

Melakukan generate Recurring Token  tanpa melakukan  terlebih dahulu

Merchant Token

SHA256 (Merchant ID + Card No + Card Exp Yymm + Merchant Key)



Request Parameter - Generate Recurring Token

Sample Java Request Generate Recurring Token


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

10

 ID

IONPAYTEST

merchantToken

Required

AN

255

 Token

b63d66156715bf8c9d851e76e61a42ce7efb815a91843b7535c5bcde8490cb4d

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



Only alphabet allowed

cardHolderEmail

Required

ANS

100

Card Holder Email

johndoe@gmail.com



Response Parameter - Generate Recurring Token

Sample Java Response Generate Recurring Token


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

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

Memeriksa Recurring Token pada  dengan 



Request Parameter - Check Recurring Token

Sample Java Request Check Recurring Token


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

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


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

resultCode

Required

N

4

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

Menghilangkan Recurring Token pada  



Request Parameter - Remove Recurring Token

Sample Java Request Remove Recurring Token


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

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


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

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



Untuk melakukan  Pre-Auth & Capture,  membutuhkan preauthToken agar dapat melakukan  capture. Proses tersebut hanya dapat dilakukan selama preauthToken masih berlaku. Berikut adalah langkah  pada  dalam menggunakan Pre-Auth Token.

  1.  akan memasukkan data kartu berupa cardNo dan ExyMmYy melalui  Request Token (onePassToken.do).
  2.  akan mendapatkan cardToken.
  3. Proses  dengan Pre-Auth pada V1 Enterprise terbagi menjadi 2, yaitu Direct 3Ds dan Direct Non-3Ds.
    • Jika melalui  3Ds, maka data kartu akan melalui verifikasi keamanan dari  3Ds Request (secureVeRequest.do) berupa OTP serta keamanan FDS (Fraud Detection System) .
    • Jika tidak melalui  3Ds, maka tidak akan melalui verifikasi keamanan.
  4.  melakukan  dengan    (onePass.do).
  5. Sistem melakukan  hold dan mendapatkan preauthToken untuk melanjutkan .
  6. Proses capture amount akan dilakukan menggunakan  Pre-Auth (captureTrans.do) dengan memasukkan preauthToken dan CVV.

Jika preauthToken kedaluwarsa, maka  akan menjadi Void dan dana akan dikembalikan kepada .

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

 Pembayaran untuk  Pre-Auth menggunakan preauthToken



Request Parameter - Pre-Auth

Sample Request Pre-Auth
Sample Java Request Pre-Auth


Parameter

Tipe

Ukuran

Deskripsi

Contoh / Catatan

iMid

Required

AN

2

 ID

IONPAYTEST

payMethod Required

N

2

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

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


Parameter

Tipe

Ukuran

Deskripsi

resultCd

N

4

Result Code

resultMsg

AN

255

tXid

AN

30

Transaction ID

referenceNo

ANS

40

 Order Number

payMethod

N

2

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

issuBankNm

A

255

Issuing  Name

acquBankCd

A

4

acquBankNm

A

255

Acquiring  Name

cardNo

ANS

20

Card Number with Masking

instmntMon

N

2

Installment Month

instmntType

N

2

ccTransType

N

2

vat

N

12

{{vat}} Number

fee

N

12

Service Fee

notaxAmt

N

12

Tax Free Amount