Pre-Auth & Capture - Payment API Credit Card
Setelah Anda melakukan pendaftaran transaksi Kartu Kredit dengan tipe fitur Pre-Auth & Capture pada Pre-Auth & Capture - Registration API Credit Card, Anda dapat melanjutkan langkah selanjutnya ke proses pembayaran pada transaksi tersebut melalui API Payment ini.
Pelajari mengenai fitur pembayaran Kartu Kredit dengan RecurringToken di halaman Fitur Kartu Kredit atau kunjungi penjelasan teknis API mengenai Pre-Auth Capture di halaman Pre-Auth & Capture - Payment 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 |
Untuk dapat melakukan fitur Pre-Auth dari transaksi yang Pelanggan Anda akan lakukan, Anda diperlukan untuk mengisi parameter tXid dari hasil response pada Pre-Auth & Capture - Registration API Credit Card yang Anda 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 | 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 | 6 | Card CVV | 100 |
callBackUrl Required | ANS | 255 | Payment Result URL | https://www.merchant.com/callbackUrl/ |
Anda juga memerlukan parameter cardNo, cardExpYymm, cardHolderNm, cardHolderEmail & cardCvv yang Anda bisa dapatkan dari Pelanggan Anda agar tagihan transaksinya dapat diproses.
Berikut ini adalah response parameter dari hasil request Pre-Auth Payment (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 | 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 | | 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 |
Apabila proses ini berhasil maka dana yang sudah dibayarkan akan di-hold secara otomatis dan Anda pun akan mendapatkan preauthToken yang diperlukan untuk melakukan proses Capture nantinya.
Mohon untuk segera melakukan proses Capture setelah proses Pre-Auth sudah diselesaikan sebelum dana transaksinya kedaluwarsa dan akan dianggap void (dana transaksi akan dikembalikan ke cardholder) Tenggat waktu kedaluwarsa pada transaksi jenis Pre-Auth biasanya memakan waktu sampai 7 hari.
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 |
Setelah Anda mendapatkan preauthToken pada transaksi yang sudah dibayarkan oleh Pelanggan Anda di proses API Pre-Auth Payment (Hold),
Langkah selanjutnya adalah melakukan proses Capture pada dana yang telah di-hold. Namun, untuk melakukan proses itu Anda diperlukan untuk registrasi kembali dengan transaksi yang baru pada Pre-Auth & Capture - Registration API Credit Card dengan amount yang Anda capture harus berjumlah kurang atau sama dari amount yang telah di-hold pada proses Pre-Auth sebelumnya.
Apabila Anda sudah sukses mendaftarkan transaksi kembali, Anda baru dapat menggunakan API Capture ini.
Proses Capture dapat dilakukan berulang kali selama jumlah amount yang sudah melalui Pre-Auth masih ada untuk di-capture beserta dengan transaksi Pre-Auth masih belum kedaluwarsa atau belum dianggap void.
Berikut ini adalah daftar parameter untuk melakukan integrasi proses pembayaran Kartu Kredit 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 | 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 tidak akan sama dengan request (preauth - hold). Proses Capture akan memastikan bahwa nilai amount yang di-capture tidak melebihi dana yang sudah Anda Pre-Auth.
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 | 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 tidak akan sama seperti request hold saat capture, dan amt tidak melebihi dana yang ditahan.
Saat Callback telah diterima callbackUrl Anda, kami sangat menganjurkan Merchant untuk melakukan verifikasi Status menggunakan Status Inquiry - API Credit Card.
CallBack Handling sangat penting untuk membantu meminimalisir tindakan Fraud, kami sangat merekomendasikan Merchant untuk melakukan verifikasi menggunakan CallBack Handling.