Pre-Auth & Capture - Payment API Credit Card
After You proceed with credit card registration with Pre-Auth & Capture feature type on Pre-Auth & Capture - Registration API Credit Card, You can proceed to the next payment step on that transaction through this API Payment.
Learn about Credit Card Payment with RecurringToken on the Credit Card Feature page or visit the technical explanation about Pre-Auth Capture in Pre-Auth & Capture - Payment API Credit Card page.
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 |
To able the Pre-auth feature from Your Customer transaction, You need to fill in the tXid parameter from the response result on Pre-Auth & Capture - Registration API Credit Card that You have already done.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20230522130518 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202305161007570327 |
referenceNo Required | ANS | 40 | Merchant Order No. | This Is The Description Of The Payment |
merchantToken Required | AN | 255 | Merchant Token | ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae |
cardHolderNm Required | AN | 45 | Card Holder Name | John Doe |
cardHolderEmail Required | ANS | 100 | Card Holder Email | |
cardCvv Required | N | 4 | Card CVV | 100 |
callBackUrl Required | AN | 255 | Payment Result Forward URL | https://www.merchant.com/callbackUrl/ |
You also need cardNo, cardExpYymm, cardHolderNm, cardHolderEmail & cardCvv parameters that You can get from Your Customer so the billing transaction can be processed.
The following is a response parameter from the request Pre-Auth Payment (Hold Fund) result.
Parameter | Type | Size | Description | Example / Notes |
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 | Merchant Order No | MerchantReferenceNumber001 |
payMethod | N | 2 | 01 When Success | |
amount | N | 12 | Payment Amount | 10000 When Success |
currency | AN | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Merchant 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 Payment When Success |
authNo | N | 10 | Approval Number | 123456 When Success |
issuBankCd | A | 4 | CENA When Success | |
acquBankCd | A | 4 | 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 | 1 When Success | |
preauthToken | AN | 64 | Pre-Auth Token | 5c6ba40e61c45d9fa37e763ea1f86b9d6ac5f1f7ed279e4d4531191c83279320 When Success |
ccTransType | AN | 2 | 3 When Success | |
vat | N | 12 | Value Added Tax (VAT) | 0 When Success |
fee | N | 12 | Service Fee | 0 When Success |
notaxAmt | N | 12 | Tax Free Amount | 0 When Success |
acquBankNm | A | 255 | Acquiring Bank Name | CIMB |
issuBankNm | A | 255 | Issuing Bank Name | BCA |
If this process is successful, the paid fund will automatically hold, and You will get the needed preauthToken to go through the later capture process.
Please proceed capture process immediately after the Pre-Auth process is finished before the transaction fund expiry and will be considered void (the transaction fund will return to the cardholder)
The expiration date on the Pre-Auth transaction type usually takes up to 7 days.
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 |
After you get the preauthToken on the paid transaction from your Customer on API Pre-Auth Payment (Hold) process.
The next step is going through capture process on the earlier held fund. However to proceed with that, You need to register again with the new transaction on Pre-Auth & Capture - Registration API Credit Card with the capture amount must be less or equal to the hold amount from the previous Pre-Auth process.
If you already success registered the transaction again, You can use this API Capture.
The capture process can be executed multiple times as long as the total amount that already went through pre-auth still available for capture include the pre-auth transaction still not yet expired or hasn't considered void.
The following is a list of parameter to integrate for the credit card payment process using PreauthToken without cardNo, cardExpYymm , or cardCvv.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20230516135959 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202305161007570327 |
referenceNo Required | ANS | 40 | Merchant Order No | MerchantReferenceNumber001 |
merchantToken Required | AN | 255 | Merchant Token | ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae |
cardHolderNm Required | AN | 45 | Card Holder Name | John Doe |
cardCvv | N | 6 | Card CVV | 100 |
callBackUrl Required | ANS | 255 | Payment 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 will never be similar with the request (pre-auth - hold). The Capture process will ensure that the capture amount value won't exceed the funds You already pre-auth..
Parameter | Type | Size | Description | Example / Notes |
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 | Merchant Order No | MerchantReferenceNumber001 |
payMethod | N | 2 | 01 When Success | |
amount | N | 12 | Payment Amount | 10000 When Success |
currency | AN | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Merchant 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 Payment When Success |
authNo | N | 10 | Approval Number | 123456 When Success |
issuBankCd | A | 4 | CENA When Success | |
acquBankCd | A | 4 | 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 | 1 When Success | |
ccTransType | AN | 2 | 3 When Success | |
vat | N | 12 | Value Added Tax (VAT) | 0 When Success |
fee | N | 12 | Service Fee | 0 When Success |
notaxAmt | N | 12 | Tax Free Amount | 0 When Success |
acquBankNm | A | 255 | Acquiring Bank Name | CIMB |
issuBankNm | A | 255 | Issuing Bank Name | BCA |
tXid will never similar with the request hold. Capture process will ensure that the capture amount value won't exceed the owned funds.
When your callback already received callbackUrl, we recommended the Merchant do the status verification using the Status Inquiry - API Credit Card.
CallBack Handling is very important to minimize the Fraud act, we highly recommend the Merchant to do the verification using callBack Handling .