Recurring - Payment API Credit Card
Pembayaran tipe Recurring adalah fitur lain dari Kartu Kredit yang dapat melakukan pembayaran suatu tagihan dari Pelanggan Anda secara berkala dengan nominal yang sama seperti yang ditagihkan pada awal pembayaran.
API yang digunakan pada tahap pembayaran ini sama dengan API untuk pembayaran tipe Full Payment & Installment dan Pre-Auth & Capture. Namun, terdapat perbedaan pada request parameter yang dikirimkan.
NICEPAY akan memberikan sebuah recurringToken sebagai parameter Payment API response yang disebut sebagai recurring token making. Merchant dapat menggunakan recurringToken pada Payment API request selanjutnya tanpa menggunakan cardNo dan cardExpYymm.
Untuk dapat mengaktifkan transaksi Kartu Kredit dengan jenis Recurring, Anda wajib membayarkan transaksi yang sudah dibuat untuk mendapatkan recurringToken terlebih dahulu.
API Endpoint | /nicepay/direct/v2/payment |
Method application/x-www-form-urlencoded | POST |
Description | Recurring Payment Credit Card |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
Spesifikasi API yang digunakan sama dengan API Recurring Token Credit Card.
Berikut adalah request payment pada Recurring untuk mendapatkan recurringToken yang di mana Anda diperlukan untuk menyelesaikan Recurring - Registration API Credit Card terlebih dahulu.
Anda masih membutuhkan cardNo, cardExpYymm, cardCvv, cardHolderNm& cardHolderEmail dari Pelanggan pada pembayaran pertama dalam skema Recurring ini.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
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 |
Berikut adalah rincian response yang Anda dapatkan. Mohon untuk melakukan save & store recurringToken yang sudah didapat demi menjalankan proses fitur Recurring pada transaksi selanjutnya dengan Kartu Kredit Pelanggan yang sama.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
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 |
Setelah melakukan pembayaran pertama dan telah mendapatkan recurringToken pada Recurring - Payment API Credit Card (First Payment).
Anda dapat menggunakan recurringToken tersebut untuk melakukan pembayaran tagihan lain menggunakan kredensial Kartu Kredit Pelanggan yang sama demi menerapkan mekanisme pembayaran secara berkala atau Recurring (subscription). Namun, untuk menjalankan proses payment continual recurring ini, Anda tetap diperlukan untuk melakukan registrasi transaksi terlebih dahulu pada Recurring - Registration API Credit Card.
Berikut adalah rincian request dan response yang digunakan pada pembayaran berikutnya menggunakan recurring token yang sama.
API Endpoint | /nicepay/direct/v2/payment |
Method application/x-www-form-urlencoded | POST |
Description | Recurring Continual Payment Credit Card |
Merchant Token | SHA256(timeStamp+iMid+referenceNo+amt+merchantKey) |
Spesifikasi API yang digunakan sama dengan API Recurring Token Credit Card.
Anda hanya perlu menggunakan recurringToken pada Payment API Recurring untuk request selanjutnya ini tanpa menggunakan parameter cardNo dan cardExpYymm.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
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 |
Mencantumkan cardCVV pada setiap transaksi bergantung dari MID tipe CVV atau Non-CVV.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
timeStamp | N | 14 | Response Date (YYYYMMDDHH24MISS) | 20230520135959 |
resultCd | N | 4 | Result Code | 0000 |
resultMsg | AN | 255 | SUCCESS | |
tXid | AN | 30 | Transaction ID | IONPAYTEST202206230959067259 |
referenceNo | ANS | 40 | Merchant Order No. | MerchantReferenceNumber001 |
payMethod | N | 2 | 01 When Success | |
amt | 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 | CENA (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 tidak akan sama dengan request hold. Proses Capture akan memastikan bahwa nilai amount yang di-capture tidak melebihi dana yang dimiliki
Saat Callback telah diterima callbackUrl Anda, kami sangat menganjurkan Merchant untuk melakukan verifikasi status menggunakan Status Inquiry - API Credit Card.
CallBack Handling dapat sangat membantu untuk meminimalisir terjadinya Fraud, kami sangat merekomendasikan Merchant untuk melakukan verifikasi CallBack Handling.