Recurring - API Payment Credit Card
Payment Recurring type is another credit card feature that can pay a particular bill from your Customer periodically with the same amount similar to the initial bill payment.
The API used in this payment stage is similar to the API for Full Payment & Installment and Pre-Auth & Capture payment types. However, there are differences in the sent parameter request.
NICEPAY will give a recurringToken as Payment API response parameter called recurring token making. Merchant can use recurringToken on the later Payment API request without using cardNo and cardExpYymm.
To activate the credit card recurring type transaction, you mandatory pay the created transaction to receive the recurringToken beforehand.
API Endpoint | /nicepay/direct/v2/payment |
Request Method application/x-www-form-urlencoded | POST |
Description | Recurring |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
The used API specification is similar to the API Recurring Token Credit Card
The following is a request payment on recurring to gain recurringToken yang where You need to finish the Recurring - Registration API Credit Card beforehand.
You still need cardNo, cardExpYymm, cardCvv, cardHolderNm & cardHolderEmail from the Customer on the first payment on this recurring scheme.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20230522080502 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202305220041509298 |
referenceNo Required | ANS | 40 | Merchant Order No | MerchantReferenceNumber001 |
merchantToken Required | AN | 255 | Merchant Token | ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae |
cardNo Required | N | 20 | Credit Card Number | 51234500****0000 |
cardExpYymm Required | A | 4 | Card Expiry (YYMM) | 3901 |
cardCvv Required | N | 4 | Card CVV | 100 |
cardHolderNm Required | AN | 45 | Card Holder Name | John Doe |
cardHolderEmail Required | ANS | 100 | Card Holder Email | |
callBackUrl Required | ANS | 255 | Payment Result URL | https://www.nicepay.co.id/IONPAY_CLIENT/paymentResult.jsp |
Below is the detailed response You get. Please perform save & store the recurringToken gain to execute the recurring feature process on the next transaction with the same Customer Credit Card.
Parameter | Type | Size | Description | Example / Notes |
timeStamp | N | 14 | Response Date (YYYYMMDDHH24MISS) | 20230520135959 |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | 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) | 20230516 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 135959 When Success |
description | AN | 100 | Transaction Description | This Is The Description Of The Payment When Success |
authNo | N | 10 | Approval Number | 123456 When Success |
issuBankCd | A | 4 | CENA (Refer Bank Code) When Success | |
acquBankCd | A | 4 | BNIA (Refer Bank Code) When Success | |
cardNo | AN | 20 | Card Number (Masked) | 51234500****0008 When Success |
cardExpYymm | N | 4 | Card Expiry (YYMM) | 3901 When Success |
instmntMon | N | 1 | Installment Month | 1 When Success |
instmntType | N | 2 | 1 When Success | |
ccTransType | AN | 2 | 2 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 |
recurringToken | AN | 64 | Token That Using Recurring Payment | f19e3128784d0b33c189d5df21321c781b5bd107b185587fd8a54781aa845c84 |
acquBankNm | A | 255 | Acquiring Bank Name | CIMB |
issuBankNm | A | 255 | Issuing Bank Name | BCA |
After proceeding with the first payment and already receiving recurringToken on Recurring - API Payment Credit Card.
You can use that recurringToken to pay another bill using a similar Customer credit card credential to implement recurring (subscription) payment mechanism. However, to proceed this payment continual recurring, You still need to beforehand do the transaction registration on Recurring - Registration API Credit Card.
The following is the request and response detail used on the later payment using the same recurring token.
API Endpoint | /nicepay/direct/v2/payment |
Request Method application/x-www-form-urlencoded | POST |
Description | Recurring Continual Payment Credit Card |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
API specification used is similar to the API Recurring Token Credit Card
You only need to use recurringToken on Payment API Recurring for this next request without using cardNo and cardExpYymm parameter.
Parameter | Type | Size | Description | Example / Notes |
timeStamp Required | N | 14 | Request Timestamp (YYYYMMDDHH24MISS) | 20230522080502 |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST01202305220041509298 |
referenceNo Required | ANS | 40 | Merchant Order No | MerchantReferenceNumber001 |
merchantToken Required | AN | 255 | Merchant Token | ff139e49606387091cd9baeadff3161aff6afd9406e1f481e0fdb8b46d1ae5ae |
cardNo Required | N | 20 | Credit Card Number | 51234500****0000 |
cardExpYymm Required | A | 4 | Card Expiry (YYMM) | 3901 |
cardCvv Required | N | 4 | Card CVV | 100 |
cardHolderNm Required | AN | 45 | Card Holder Name | John Doe |
cardHolderEmail Required | ANS | 100 | Card Holder Email
| |
callBackUrl Required | ANS | 255 | Payment Result URL | https://www.nicepay.co.id/IONPAY_CLIENT/paymentResult.jsp |
Include cardCVV on every transaction depending on the MID type of cvv or non-cvv.
Parameter | Type | Size | Description | Example / Notes |
timeStamp | N | 14 | Response Date (YYYYMMDDHH24MISS) | 20230520135959 |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | 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 | Transaction Description | This Is The Description Of The Payment When Success |
authNo | N | 10 | Approval Number | 123456 When Success |
issuBankCd | A | 4 | CENA (Refer Bank Code) When Success | |
acquBankCd | A | 4 | BNIA (Refer Bank Code) When Success | |
cardNo | AN | 20 | Card Number (Masked) | 51234500****0008 When Success |
cardExpYymm | N | 4 | Card Expiry (YYMM) | 3901 When Success |
instmntMon | N | 1 | Installment Month | 1 When Success |
instmntType | N | 2 | 1 When Success | |
ccTransType | AN | 2 | 2 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 to 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 .