Pre-Auth & Capture - Payment API Credit Card

18min

Tentang Pre-Auth & Capture - Payment API Credit Card
﻿
Setelah ﻿ melakukan pendaftaran ﻿ ﻿ dengan tipe fitur Pre-Auth & Capture pada Pre-Auth & Capture - Registration API Credit Card﻿, ﻿ dapat melanjutkan langkah selanjutnya ke ﻿ ﻿ pada ﻿ tersebut melalui ﻿ ﻿ ini. 
Pelajari mengenai fitur ﻿ ﻿ dengan RecurringToken di ﻿ Fitur Kartu Kredit﻿ atau kunjungi penjelasan teknis ﻿ mengenai Pre-Auth Capture di ﻿ Pre-Auth & Capture - Payment API Credit Card﻿.
﻿
Pre-Auth - Payment (Hold Fund) API Credit Card
﻿

API Endpoint
/nicepay/direct/v2/payment
Request Method
﻿POST﻿
Description
Pre-Auth (Hold Fund)
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format
application/json
﻿
Request Parameter Pre-Auth (Hold Fund) - Payment API Credit Card 
﻿

Untuk dapat melakukan fitur Pre-Auth dari ﻿ ﻿ ﻿ ﻿ akan lakukan, ﻿ diperlukan untuk mengisi ﻿ tXid dari hasil response pada Pre-Auth & Capture - Registration API Credit Card﻿ ﻿ ﻿ sudah lakukan sebelumnya. 
Parameter
Tipe
Ukuran 
Deskripsi
Contoh / Catatan
timeStamp
﻿Required﻿
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20230522130518
tXid
﻿Required﻿
AN
30

Transaction ID	
IONPAYTEST01202305161007570327
referenceNo
﻿Required﻿
ANS
40
﻿﻿ Order Number
This Is The Description Of The ﻿ 
merchantToken
﻿Required﻿
AN
255
﻿﻿ Token
ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae
cardHolderNm
﻿Required﻿
AN
45
Card Holder Name
John Doe
﻿
Only alphabet allowed
cardHolderEmail
﻿Required﻿
ANS
100
Card Holder Email
johndoe@gmail.com
cardCvv
﻿Required﻿
N
6
Card CVV
100
callBackUrl
﻿Required﻿
ANS
255
﻿﻿ Result URL
https://www.merchant.com/callbackUrl/
﻿﻿ juga memerlukan ﻿ cardNo, cardExpYymm, cardHolderNm, cardHolderEmail & cardCvv ﻿ ﻿ bisa dapatkan dari ﻿ ﻿ agar tagihan ﻿nya dapat di﻿. 
﻿
Response Parameter Pre-Auth (Hold Fund) - Payment API Credit Card 
﻿

Berikut ini adalah response ﻿ dari hasil request Pre-Auth ﻿ (Hold Fund).
Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
timeStamp
N
14
Response Date
(YYYYMMDDHH24MISS)
20230516135959
resultCd
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
Result Message: Error Code﻿﻿
SUCCESS
tXid
AN
30
Transaction ID
IONPAYTEST01202305161007570327
referenceNo
ANS
40
﻿﻿ Order Number
MerchantReferenceNumber001
payMethod
N
2
﻿Payment Method Code﻿﻿
01
﻿
When Success
amount
N
12
﻿﻿ Amount
10000
﻿
When Success
currency
AN
3
Currency
IDR
﻿
When Success
goodsNm
AN
100
Goods Name
﻿﻿ Goods 1
﻿
When Success
billingNm
AN
100
Buyer Name
John Doe
﻿
When Success
transDt
N
8
Transaction Date
(YYYYMMDD)
20230522

When Success
transTm
N
6
Transaction Time
(HH24MISS)
135959
﻿
When Success
description
AN
100
Description
This Is The Description Of The ﻿ 
﻿
When Success
authNo
N
10
Approval Number
123456
﻿
When Success
issuBankCd
A
4
﻿Issuing Bank Code﻿﻿
CENA
﻿
When Success
acquBankCd
A
4
﻿Acquiring Bank Code﻿﻿
BNIA
﻿
When Success
cardNo
AN
20
Card Number 
(Masked)
443426******0008
﻿
When Success

cardExpYymm
N
4
Card Expiry
(YYMM)
3901
﻿
When Success
instmntMon
N
2
Installment Month
1
﻿
When Success
instmnType
N
2
﻿Installment Type Code﻿﻿
1
﻿
When Success
preauthToken
AN
﻿
Pre-Auth Token
5c6ba40e61c45d9fa37e763ea1f86b9d6ac5f1f7ed279e4d4531191c83279320
When Success
ccTransType
AN
2
﻿Credit Card Transaction Type﻿﻿
3
﻿
When Success
vat
N
12
Value Added Tax
(﻿)
0
﻿
When Success
fee
N
12
Service Fee
0
﻿
When Success
notaxAmt
N
12
Tax Free Amount
0
﻿
When Success
acquBankNm
A
255
Acquiring ﻿ Name
CIMB
issuBankNm
A
255
Issuing ﻿ Name
BCA
Apabila ﻿ ini berhasil maka dana ﻿ sudah dibayarkan akan di-hold secara otomatis dan ﻿ pun akan mendapatkan preauthToken ﻿ diperlukan untuk melakukan ﻿ Capture nantinya.
Mohon untuk segera melakukan ﻿ Capture setelah ﻿ Pre-Auth sudah diselesaikan sebelum dana ﻿nya kedaluwarsa dan akan dianggap void (dana ﻿ akan dikembalikan ke cardholder)

Tenggat waktu kedaluwarsa pada ﻿ jenis Pre-Auth biasanya memakan waktu sampai 7 hari.
﻿
Sample JSON Credit Card - Pre-Auth (Hold Fund) - Payment API Credit Card 
﻿

Sample Request PreAuth Hold
Sample Response PreAuth Hold
Java Request
//Credit Card Pre-Auth Hold

//Initialize Parameters
nicePay.setTimeStamp("20230516135959");
nicePay.settXid("IONPAYTEST01202305161007570327");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setMerchantToken("c91e6531f6c84869439bc5ebe5389bd71e7752c054fc9dbfe193d087a1b797ae");
nicePay.setCardNo("4434260000000008");
nicePay.setCardExpYymm("3901");
nicePay.setCardCvv("100");
nicePay.setCardHolderNm("John Doe");
nicePay.setCardHolderEmail("johndoe@gmail.com");
nicePay.setCallbackUrl("https://www.merchant.com/callbackUrl/");

//Request Credit Card Pre-Auth Hold
nicePay.ccPACHold();

//Response Credit Card Pre-Auth Hold
System.out.println("Response : " + nicePay.getResponseString());
String resultCd = nicePay.get("resultCd");
String resultMsg = nicePay.get("resultMsg");
String authNo = nicePay.get("authNo");
String tXid = nicePay.get("tXid");
String referenceNo = nicePay.get("referenceNo");
String transDt = nicePay.get("transDt");
String transTm = nicePay.get("transTm");
String amount = nicePay.get("amount");
String preauthToken = nicePay.get("preauthToken");
String cardNo = nicePay.get("cardNo");
String acquBankCd = nicePay.get("acquBankCd");
String issuBankCd = nicePay.get("issuBankCd");
String acquBankNm = nicePay.get("acquBankNm");
String issuBankNm = nicePay.get("issuBankNm");
//Credit Card Pre-Auth Hold

//Initialize Parameters
nicePay.setTimeStamp("20230516135959");
nicePay.settXid("IONPAYTEST01202305161007570327");
nicePay.setReferenceNo("MerchantReferenceNumber001");
nicePay.setMerchantToken("c91e6531f6c84869439bc5ebe5389bd71e7752c054fc9dbfe193d087a1b797ae");
nicePay.setCardNo("4434260000000008");
nicePay.setCardExpYymm("3901");
nicePay.setCardCvv("100");
nicePay.setCardHolderNm("John Doe");
nicePay.setCardHolderEmail("johndoe@gmail.com");
nicePay.setCallbackUrl("https://www.merchant.com/callbackUrl/");

//Request Credit Card Pre-Auth Hold
nicePay.ccPACHold();

//Response Credit Card Pre-Auth Hold
System.out.println("Response : " + nicePay.getResponseString());
String resultCd = nicePay.get("resultCd");
String resultMsg = nicePay.get("resultMsg");
String authNo = nicePay.get("authNo");
String tXid = nicePay.get("tXid");
String referenceNo = nicePay.get("referenceNo");
String transDt = nicePay.get("transDt");
String transTm = nicePay.get("transTm");
String amount = nicePay.get("amount");
String preauthToken = nicePay.get("preauthToken");
String cardNo = nicePay.get("cardNo");
String acquBankCd = nicePay.get("acquBankCd");
String issuBankCd = nicePay.get("issuBankCd");
String acquBankNm = nicePay.get("acquBankNm");
String issuBankNm = nicePay.get("issuBankNm");
﻿
﻿
Capture - Payment API Credit Card
﻿

API URL
/nicepay/direct/v2/payment
Request Method
﻿POST﻿
Description
Capture Process from Pre-Auth
Merchant Token
SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format
application/json
﻿
Request Parameter Capture - Payment API Credit Card
﻿
Setelah ﻿ mendapatkan preauthToken pada ﻿ ﻿ sudah dibayarkan oleh ﻿ ﻿ dan di﻿ API Pre-Auth Payment (Hold), 
Langkah selanjutnya adalah melakukan ﻿ Capture pada dana ﻿ telah di-hold. Namun, untuk melakukan ﻿ itu, ﻿ diperlukan untuk registrasi kembali dengan ﻿ ﻿ baru pada Pre-Auth & Capture - Registration API Credit Card﻿ dengan amount ﻿ ﻿ capture harus berjumlah kurang atau sama dari amount ﻿ telah di-hold pada ﻿ Pre-Auth sebelumnya.
Apabila ﻿ sudah sukses mendaftarkan ﻿ kembali, ﻿ baru dapat menggunakan ﻿ Capture ini.
Proses Capture dapat dilakukan berulang kali selama jumlah amount ﻿ sudah melalui Pre-Auth masih ada untuk di-capture beserta dengan ﻿ Pre-Auth masih belum kedaluwarsa atau belum dianggap void.
Berikut ini adalah daftar ﻿ untuk melakukan ﻿ ﻿ ﻿ ﻿ menggunakan PreauthToken tanpa cardNo, cardExpYymm maupun cardCvv.
Parameter
Tipe
Ukuran 
Deskripsi
Contoh / Catatan
timeStamp
﻿Required﻿
N
14
Request Timestamp (YYYYMMDDHH24MISS)
20230516135959
tXid
﻿Required﻿
AN
30

Transaction ID	
IONPAYTEST01202305161007570327
referenceNo
﻿Required﻿
ANS
40
﻿﻿ Order Number
MerchantReferenceNumber001
merchantToken
﻿Required﻿
AN
255
﻿﻿ Token
ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae
cardHolderNm
﻿Required﻿
AN
45
Card Holder Name
John Doe
﻿
Only alphabet allowed
cardCvv
﻿
N
6
Card CVV
100
callBackUrl
﻿Required﻿
ANS
255
﻿﻿ Result URL
https://www.nicepay.co.id/IONPAY_CLIENT/paymentResult.jsp
preauthToken
﻿Required For Capture Process in Pre-Auth﻿
AN
64
Pre-Auth Token	
5976c263fe6116503645057bb00be809c3a6f9c1e355efa12ef2cda2be03d5eb
tXid tidak akan sama dengan request (preauth - hold). Proses Capture akan memastikan bahwa nilai amount ﻿ di-capture tidak melebihi dana ﻿ sudah ﻿ Pre-Auth.
﻿
Response Parameter Capture - Payment API Credit Card
﻿

Parameter
Tipe
Ukuran
Deskripsi
Contoh / Catatan
timeStamp
N
14
Response Date
(YYYYMMDDHH24MISS)
20230516135959
resultCd
N
4
﻿Result Code﻿﻿
0000
resultMsg
AN
255
Result Message: Error Code﻿﻿
SUCCESS
tXid
AN
30
Transaction ID
IONPAYTEST01202305161007570327
referenceNo
ANS
40
﻿﻿ Order Number
MerchantReferenceNumber001
payMethod
N
2
﻿Payment Method Code﻿﻿
01
﻿
When Success
amount
N
12
﻿﻿ Amount
10000
﻿
When Success
currency
AN
3
Currency
IDR
﻿
When Success
goodsNm
AN
100
Goods Name
﻿﻿ Goods 1
﻿
When Success
billingNm
AN
100
Buyer Name
John Doe
﻿
When Success
transDt
N
8
Transaction Date
(YYYYMMDD)
20230522

When Success
transTm
N
6
Transaction Time
(HH24MISS)
224343
﻿
When Success
description
AN
100
Description
This Is The Description Of The ﻿ 
﻿
When Success
authNo
N
10
Approval Number
123456
﻿
When Success
issuBankCd
A
4
﻿Issuing Bank Code﻿﻿
CENA
﻿
When Success
acquBankCd
A
4
﻿Acquiring Bank Code﻿﻿
BNIA
﻿
When Success
cardNo
AN
20
Card Number 
(Masked)
51234500****0008
﻿
When Success

cardExpYymm
N
4
Card Expiry
(YYMM)
3901
﻿
When Success
instmntMon
N
2
Installment Month
1
﻿
When Success
instmnType
N
2
﻿Installment Type Code﻿﻿
1
﻿
When Success
ccTransType
AN
2
﻿Credit Card Transaction Type﻿﻿
3
﻿
When Success
vat
N
12
Value Added Tax
(﻿)
0
﻿
When Success
fee
N
12
Service Fee
0
﻿
When Success
notaxAmt
N
12
Tax Free Amount
0
﻿
When Success
acquBankNm
A
255
Acquiring ﻿ Name
CIMB
issuBankNm
A
255
Issuing ﻿ Name
BCA
tXid tidak akan sama seperti request hold saat capture, dan amt tidak melebihi dana ﻿ ditahan.
﻿
Sample JSON Credit Card Capture - Payment API Credit Card
﻿

Sample Request Pre-Auth Capture
Sample Response Pre-Auth Capture
Java Request
{
  "resultCd": "0000",
  "resultMsg": "SUCCESS",
  "authNo": "063471",
  "tXid": "IONPAYTEST01202305161007570327",
  "referenceNo": "MerchantReferenceNumber001",
  "transDt": "20230522",
  "transTm": "224343",
  "amount": "10000",
  "cardNo": "51234500****0008",
  "acquBankCd": "BNIA",
  "issuBankCd": "CENA",
  "acquBankNm": "CIMB",
  "issuBankNm": "BCA"
}
{
  "resultCd": "0000",
  "resultMsg": "SUCCESS",
  "authNo": "063471",
  "tXid": "IONPAYTEST01202305161007570327",
  "referenceNo": "MerchantReferenceNumber001",
  "transDt": "20230522",
  "transTm": "224343",
  "amount": "10000",
  "cardNo": "51234500****0008",
  "acquBankCd": "BNIA",
  "issuBankCd": "CENA",
  "acquBankNm": "CIMB",
  "issuBankNm": "BCA"
}
﻿
﻿
CallBack Handling for Credit Card Payment Pre-Auth
﻿
Saat Callback telah diterima callbackUrl ﻿, kami sangat menganjurkan ﻿ untuk melakukan verifikasi Status menggunakan Status Inquiry - API Credit Card﻿.
CallBack Handling sangat penting untuk membantu meminimalisir tindakan Fraud, kami sangat merekomendasikan ﻿ untuk melakukan verifikasi menggunakan CallBack Handling.
URL CallBack
Response CallBack
{
    "resultCd":"0000",
    "resultMsg":"SUCCESS",
    "tXid":"IONPAYTEST01202212141112221428",
    "referenceNo":"",
    "payMethod":"01",
    "amt":"10000",
    "transDt":"20221212",
    "transTm":"121212",
    "description":"Testing Credit Card Transaction",
    "authNo":"080623",
    "issuBankCd":"OTHR"
    "acquBankCd":"BMRI",
    "cardNo":"453211*****1111",
    "goodsNm":"Test Transaction Nicepay"
    "billingNm":"John Doe",
    "currency":"IDR",
    "timeStamp":"20221212121212",
    "merchantToken":"2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6",
    "cardExpYymm":"2712",
    "instmntMon":"1",
    "instmntType":"1",
    "ccTransType":"1"
}
{
    "resultCd":"0000",
    "resultMsg":"SUCCESS",
    "tXid":"IONPAYTEST01202212141112221428",
    "referenceNo":"",
    "payMethod":"01",
    "amt":"10000",
    "transDt":"20221212",
    "transTm":"121212",
    "description":"Testing Credit Card Transaction",
    "authNo":"080623",
    "issuBankCd":"OTHR"
    "acquBankCd":"BMRI",
    "cardNo":"453211*****1111",
    "goodsNm":"Test Transaction Nicepay"
    "billingNm":"John Doe",
    "currency":"IDR",
    "timeStamp":"20221212121212",
    "merchantToken":"2035d2295d9578fffb40137186f0203474142ae3e57992d4847826c5fcaffce6",
    "cardExpYymm":"2712",
    "instmntMon":"1",
    "instmntType":"1",
    "ccTransType":"1"
}
﻿

API Endpoint	/nicepay/direct/v2/payment
Request Method	POST
Description	Pre-Auth (Hold Fund)
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format	application/json

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20230522130518
tXid Required	AN	30	Transaction ID	IONPAYTEST01202305161007570327
referenceNo Required	ANS	40	Order Number	This Is The Description Of The
merchantToken Required	AN	255	Token	ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae
cardHolderNm Required	AN	45	Card Holder Name	John Doe Only alphabet allowed
cardHolderEmail Required	ANS	100	Card Holder Email	johndoe@gmail.com
cardCvv Required	N	6	Card CVV	100
callBackUrl Required	ANS	255	Result URL	https://www.merchant.com/callbackUrl/

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
timeStamp	N	14	Response Date (YYYYMMDDHH24MISS)	20230516135959
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	IONPAYTEST01202305161007570327
referenceNo	ANS	40	Order Number	MerchantReferenceNumber001
payMethod	N	2	Payment Method Code	01 When Success
amount	N	12	Amount	10000 When Success
currency	AN	3	Currency	IDR When Success
goodsNm	AN	100	Goods Name	Goods 1 When Success
billingNm	AN	100	Buyer Name	John Doe When Success
transDt	N	8	Transaction Date (YYYYMMDD)	20230522 When Success
transTm	N	6	Transaction Time (HH24MISS)	135959 When Success
description	AN	100	Description	This Is The Description Of The When Success
authNo	N	10	Approval Number	123456 When Success
issuBankCd	A	4	Issuing Bank Code	CENA When Success
acquBankCd	A	4	Acquiring Bank Code	BNIA When Success
cardNo	AN	20	Card Number (Masked)	443426******0008 When Success
cardExpYymm	N	4	Card Expiry (YYMM)	3901 When Success
instmntMon	N	2	Installment Month	1 When Success
instmnType	N	2	Installment Type Code	1 When Success
preauthToken	AN		Pre-Auth Token	5c6ba40e61c45d9fa37e763ea1f86b9d6ac5f1f7ed279e4d4531191c83279320 When Success
ccTransType	AN	2	Credit Card Transaction Type	3 When Success
vat	N	12	Value Added Tax ()	0 When Success
fee	N	12	Service Fee	0 When Success
notaxAmt	N	12	Tax Free Amount	0 When Success
acquBankNm	A	255	Acquiring Name	CIMB
issuBankNm	A	255	Issuing Name	BCA

API URL	/nicepay/direct/v2/payment
Request Method	POST
Description	Capture Process from Pre-Auth
Merchant Token	SHA256(timeStamp+iMid+referenceNo+amt+merchantKey)
Request Format	application/json

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
timeStamp Required	N	14	Request Timestamp (YYYYMMDDHH24MISS)	20230516135959
tXid Required	AN	30	Transaction ID	IONPAYTEST01202305161007570327
referenceNo Required	ANS	40	Order Number	MerchantReferenceNumber001
merchantToken Required	AN	255	Token	ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae
cardHolderNm Required	AN	45	Card Holder Name	John Doe Only alphabet allowed
cardCvv	N	6	Card CVV	100
callBackUrl Required	ANS	255	Result URL	https://www.nicepay.co.id/IONPAY_CLIENT/paymentResult.jsp
preauthToken Required For Capture Process in Pre-Auth	AN	64	Pre-Auth Token	5976c263fe6116503645057bb00be809c3a6f9c1e355efa12ef2cda2be03d5eb

Parameter	Tipe	Ukuran	Deskripsi	Contoh / Catatan
timeStamp	N	14	Response Date (YYYYMMDDHH24MISS)	20230516135959
resultCd	N	4	Result Code	0000
resultMsg	AN	255	Result Message: Error Code	SUCCESS
tXid	AN	30	Transaction ID	IONPAYTEST01202305161007570327
referenceNo	ANS	40	Order Number	MerchantReferenceNumber001
payMethod	N	2	Payment Method Code	01 When Success
amount	N	12	Amount	10000 When Success
currency	AN	3	Currency	IDR When Success
goodsNm	AN	100	Goods Name	Goods 1 When Success
billingNm	AN	100	Buyer Name	John Doe When Success
transDt	N	8	Transaction Date (YYYYMMDD)	20230522 When Success
transTm	N	6	Transaction Time (HH24MISS)	224343 When Success
description	AN	100	Description	This Is The Description Of The When Success
authNo	N	10	Approval Number	123456 When Success
issuBankCd	A	4	Issuing Bank Code	CENA When Success
acquBankCd	A	4	Acquiring Bank Code	BNIA When Success
cardNo	AN	20	Card Number (Masked)	51234500****0008 When Success
cardExpYymm	N	4	Card Expiry (YYMM)	3901 When Success
instmntMon	N	2	Installment Month	1 When Success
instmnType	N	2	Installment Type Code	1 When Success
ccTransType	AN	2	Credit Card Transaction Type	3 When Success
vat	N	12	Value Added Tax ()	0 When Success
fee	N	12	Service Fee	0 When Success
notaxAmt	N	12	Tax Free Amount	0 When Success
acquBankNm	A	255	Acquiring Name	CIMB
issuBankNm	A	255	Issuing Name	BCA

Recurring - Payment API Credit Card

Cancel - API Credit Card

Pre-Auth & Capture - Payment API Credit Card

Tentang Pre-Auth & Capture - Payment API Credit Card

Pre-Auth - Payment (Hold Fund) API Credit Card

Request Parameter Pre-Auth (Hold Fund) - Payment API Credit Card

Response Parameter Pre-Auth (Hold Fund) - Payment API Credit Card

Sample JSON Credit Card - Pre-Auth (Hold Fund) - Payment API Credit Card

Capture - Payment API Credit Card

Request Parameter Capture - Payment API Credit Card

Response Parameter Capture - Payment API Credit Card

Sample JSON Credit Card Capture - Payment API Credit Card

CallBack Handling for Credit Card Payment Pre-Auth

Selamat Datang di NICEPAY DOCS