Credit Card - API Checkout
Terdapat beberapa hal yang Anda wajib ketahui dalam menggunakan API Checkout untuk metode Kartu Kredit agar proses integrasi Anda lancar bersama kami:
- Proses Flow 3Ds/Non-3Ds.
- Fitur Full Payment.
- Fitur Installment.
- Fitur Recurring Token.
- Fitur Pre-Auth Token.
Silakan kunjungi halaman Fitur Kartu Kredit untuk memeriksa penjelasan mengenai 3Ds.
![Alur Pembayaran CC - Redirect 3Ds Alur Pembayaran CC - Redirect 3Ds](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/-B7a6C3IMu5oNYpnz84pR_nicepay-archbee-payment-cc-new-cc-redirect-3ds.png?format=webp)
Deskripsi langkah alur pembayaran Kartu Kredit redirect dengan 3Ds:
- Pelanggan melakukan checkout.
- Pelanggan mengirim data checkout kepada Merchant.
- Merchant mengajukan checkout menggunakan API Registration kepada NICEPAY.
- NICEPAY mendaftarkan data checkout.
- NICEPAY mengalihkan pembayaran pada halaman milik NICEPAY kepada Merchant.
- Merchant mengirimkan halaman pembayaran NICEPAY kepada Pelanggan.
- Pelanggan memilih metode pembayaran.
- Pelanggan memasukkan data kartu.
- Pelanggan mengirimkan Informasi data kartu kepada NICEPAY.
- NICEPAY memproses kalkulasi FDS.
- NICEPAY mengajukan 3Ds kepada Bank.
- Bank melakukan validasi 3Ds.
- Bank mengirimkan response URL 3Ds kepada NICEPAY.
- NICEPAY menerima response verifikasi.
- NICEPAY mengalihkan Pelanggan kepada halaman autentikasi ACS.
- Bank membuat response OTP.
- Bank mengirimkan OTP kepada Pelanggan.
- Pelanggan menerima OTP.
- Pelanggan memasukkan OTP.
- Pelanggan mengirimkan OTP kepada Bank.
- Bank melakukan verifikasi OTP.
- Bank mengirimkan hasil 3Ds kepada NICEPAY.
- NICEPAY menerima hasil pemeriksaan.
- NICEPAY mengajukan pembayaran kepada Bank.
- Bank melakukan proses pembayaran.
- Bank mengirimkan notifikasi pembayaran kepada NICEPAY.
- NICEPAY melakukan redirect callbackUrl kepada Merchant.
- Merchant menampilkan hasil callbackUrl kepada Pelanggan.
- NICEPAY mengirim notifikasi pembayaran kepada Merchant.
- Merchant menerima notifikasi.
- Merchant melakukan pengajuan status inquiry ke NICEPAY.
- NICEPAY menerima pengajuan.
- NICEPAY secara otomatis mengirimkan response status inquiry kepada Merchant.
- Merchant menerima status terakhir.
- Merchant mengirim halaman hasil transaksi kepada Pelanggan.
![Alur Pembayaran CC - Redirect Non-3Ds Alur Pembayaran CC - Redirect Non-3Ds](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/eAcndroEzJ_AXG8-rTp7B_nicepay-archbee-payment-cc-redirect-non3ds.png?format=webp)
Deskripsi langkah alur pembayaran Kartu Kredit redirect dengan Non-3Ds:
- Pelanggan melakukan checkout.
- Pelanggan mengajukan checkout kepada Merchant.
- Merchant mendaftarkan data checkout.
- Merchant mengirimkan response berupa formulir data kartu.
- Pelanggan mengajukan checkout kepada Merchant.
- Merchant mendaftarkan pesanan dengan menggunakan Registration API kepada NICEPAY.
- NICEPAY menyimpan order registration.
- NICEPAY mengalihkan Merchant kepada halaman NICEPAY.
- Merchant mengirim halaman NICEPAY kepada Pelanggan.
- Pelanggan memilih metode pembayaran.
- Pelanggan memasukkan rincian kartu.
- Pelanggan mengajukan pembayaran menggunakan API Payment kepada NICEPAY.
- NICEPAY melakukan kalkulasi FDS.
- NICEPAY mengajukan pembayaran kepada Bank.
- Bank melakukan verifikasi pengajuan.
- Bank mengirimkan pengajuan konfirmasi pembayaran kepada Pelanggan.
- Pelanggan mengajukan pembayaran/charge kepada Bank.
- Bank melakukan proses pembayaran.
- Bank mengirim response pembayaran kepada NICEPAY.
- NICEPAY mengirim notifikasi pembayaran menggunakan callBackUrl dan dbProcessUrl kepada Merchant.
- Merchant menerima notifikasi.
- Merchant mengajukan pemeriksaan status kepada NICEPAY.
- NICEPAY mengirimkan response pemeriksaan status.
- Merchant menerima status terakhir.
- Merchant mengirimkan hasil pesanan kepada Pelanggan.
Silakan membuka halaman Panduan Bayar Kartu Kredit untuk dapat memberikan panduan pembayaran kepada Pelanggan Anda dalam metode Kartu Kredit.
![Secure Payment Page Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/ml9NiRJ7kXWDfWKPVIowK_id-new-secure-payment-page-gpn.png?format=webp)
Gambar di atas adalah contoh pembayaran dengan metode Kartu Kredit menggunakan NICEPAY Secure Payment Page.
Setelah Pelanggan memilih metode dengan Kartu Kredit, Pelanggan akan diminta untuk memasukan data kartunya. Sistem NICEPAY akan secara otomatis mengenali jenis kartu BIN Pelanggan seperti gambar di bawah ini, misalnya VISA atau Mastercard, American Express, dan lain-lain yang nantinya kartunya pun akan berbeda sesuai dengan tipe jenis kartu yang digunakan.
Setelah selesai memasukkan data kartu, Pelanggan Anda dapat melanjutkan proses pembayaran.
![Credit Card - Secure Payment Page Credit Card - Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/UIcm59Oz3b1wPZDjtQXfk_secure-payment.jpg?format=webp)
Kemudian, proses transaksi akan berjalan. Apabila transaksi berhasil maka tampilan halaman pembayaran NICEPAY akan muncul seperti gambar berikut.
![Success - Secure Payment Page Success - Secure Payment Page](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/EzqMmxZP2GaRojl1QALsg_id-new-secure-payment-page-cc-2.png?format=webp)
Silakan kunjungi halaman Payment - API Checkout untuk mengetahui langkah selanjutnya perihal payment handling.
Pada Full Payment Kartu Kredit, Pelanggan membayar secara penuh nominal yang ditagihkan dalam sekali bayar. Berikut adalah rincian API yang digunakan pada pembayaran Kartu Kredit.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
paymentURL Required | ANS | 14 | Payment URL | https://dev.nicepay.co.id/nicepay/redirect/v2/payment |
tXid Required | AN | 30 | Transaction ID | IONPAYTEST00202203211640309389 |
Untuk API Payment Checkout, metode pembayaran Kartu Kredit dengan Full Payment dan Installment mendapatkan response yang sama.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
status | N | 1 | 0 | |
tXid | AN | 30 | Transaction ID | IONPAYTEST00202212201540174369 When Success |
referenceNo | AN | 40 | Merchant Order Number | ordNo20221220151243 When Success |
payMethod | N | 2 | 01 When Success | |
amt | N | 12 | Transaction Amount | 1000 When Success |
notaxAmt | N | 12 | Tax Fee Amount | 0 When Success |
vat | N | 12 | Value Added Tax (VAT) | 0 When Success |
fee | N | 12 | Service Fee | 0 When Success |
currency | A | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Goods+For+Testing+Credit+Card When Success |
billingNm | A | 100 | Billing Name | John+Doe When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221220 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 154017 When Success |
authNo | N | 10 | Approval Number | 174300 When Success (Additional) |
issuBankCd | A | 4 | BMRI When Success | |
acquBankCd | A | 4 | BMRI When Success | |
issuBankNm | A | 255 | Issuing Bank Name | Mandiri When Success |
acquBankNm | A | 255 | Acquiring Bank Name | Mandiri When Success |
ccTransType | AN | 2 | 1 When Success | |
cardNo | ANS | 20 | Card Number With Masking | 46161111****1111 When Success |
cardExpYymm | N | 4 | Card Expiration (YYMM) | 2707 When Success |
instmntType | N | 2 | 1 When Success | |
instmntMon | N | 2 | Installment Month 1: 1 Month/Full Payment, jika instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months | 1 When Success |
recurringToken | AN | 255 | Recurring Token | null When Success |
preauthToken | AN | 255 | Pre-Auth Token | null When Success |
matchCl | N | 1 | 1 When Success | |
merchantToken | AN | 255 | Merchant Token | 8f5b330a549c167b53b4b9fd5f2d2eba897a64235c1610524074ec59f8884e8a When Success |
Catatan: Response parameter akan dikirimkan melalui callBackurl dengan Content-type: application/json dan metode: POST Parameter.
Untuk proses integrasi Payment pada Checkout API, response dari request yang didapat setelah melakukan API Call Request adalah Callback URL.
API URL | /nicepay/redirect/v2/payment |
Request Method | Redirect-GET |
Header | Content-Type: application/Form-UrlEncoded |
Endpoint di atas dapat digunakan untuk metode pembayaran Kartu Kredit dengan tipe Full Payment, Recurring, dan PAC (Pre-Auth Capture).
Setelah Merchant menyelesaikan Registration - API Checkout dan Payment - API Checkout, maka selanjutnya NICEPAY akan memberikan recurringToken pada response Payment - API Checkout yang didapatkan.
Pada transaksi selanjutnya dengan Pelanggan yang sama, Merchant dapat menggunakan recurringToken tersebut dengan menggunakan API pada Recurring - Payment API Credit Card.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
paymentURL Required | ANS | 14 | Payment URL | https://dev.nicepay.co.id/nicepay/redirect/v2/payment |
tXid Required | AN | 30 | Transaction ID | RECURRTEST00202212221422115631 |
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
status | N | 1 | 0 | |
tXid | AN | 30 | Transaction ID | RECURRTEST00202212221422115631 When Success |
referenceNo | AN | 40 | Merchant Order Number | ordNo20221222141245 When Success |
payMethod | N | 2 | 01 When Success | |
amt | N | 12 | Transaction Amount | 1000 When Success |
notaxAmt | N | 12 | Tax Fee Amount | 0 When Success |
vat | N | 12 | Value Added Tax (VAT) | 0 When Success |
fee | N | 12 | Service Fee | 0 When Success |
currency | A | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Goods+For+Testing+Recurring+Token When Success |
billingNm | A | 100 | Billing Name | John+Doe When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221220 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 142211 When Success |
authNo | N | 10 | Approval Number | 115631 When Success (Additional) |
issuBankCd | A | 4 | OTHR When Success | |
acquBankCd | A | 4 | BMRI When Success | |
issuBankNm | A | 255 | Issuing Bank Name | (empty) When Success |
acquBankNm | A | 255 | Acquiring Bank Name | Mandiri When Success |
ccTransType | AN | 2 | 1 When Success | |
cardNo | ANS | 20 | Card Number With Masking | 45321111****1111 When Success |
cardExpYymm | N | 4 | Card Expiry (YYMM) | 2712 When Success |
instmntType | N | 2 | 1 When Success | |
instmntMon | N | 2 | Installment Month 1: 1 Month/Full Payment, jika instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months | 1 When Success |
recurringToken | AN | 255 | Recurring Token | 083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745 When Success |
preauthToken | AN | 255 | Pre-Auth Token | null When Success |
matchCl | N | 1 | Payment Amount Match Flag: Notification Match Amount Indicator | 1 When Success |
merchantToken | AN | 255 | Merchant Token | f083333e129dea0535119b71813b1dc67b565e2704958411d2ee2ec2f430d745 |
Setelah melakukan registrasi API (Registration - API Checkout) dan integrasi Payment API (Payment - API Checkout) menggunakan Checkout API,
- Jika Anda ingin melakukan Payment Credit Card Recurring menggunakan Recurring Token yang sama, silakan melakukan Registrasi kembali pada Registration - API Checkout .
- Kemudian melakukan pembayaran dengan menambahkan Recurring Token pada parameter recurringToken dan juga CVV.
Ketika Merchant menandatangani kontrak sebagai Merchant PAC(Pre-Auth/Capture), NICEPAY memberikan sebuah preauthToken kepada response Payment - API Checkout. Token tersebut akan digunakan pada proses capture amount untuk menyelesaikan transaksi pada Pre-Auth & Capture - Payment API Credit Card.
Berikut ini adalah daftar parameter untuk melakukan request Pre-Auth Token Credit Card. Parameter ini digunakan melalui platform pengujian API sebagai salah satu tahapan supaya sistem milik Merchant dapat terhubung dengan layanan dari NICEPAY.
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
paymentURL Required | ANS | 14 | Payment URL | https://dev.nicepay.co.id/nicepay/redirect/v2/payment |
tXid Required | AN | 30 | Transaction ID | PACTEST00100202212221548525731 |
Parameter | Tipe | Ukuran | Deskripsi | Contoh / Catatan |
status | N | 1 | 5 | |
tXid | AN | 30 | Transaction ID | PACTEST00100202212221548525731 When Success |
referenceNo | AN | 40 | Merchant Order Number | ordNo20221222151220 When Success |
payMethod | N | 2 | 01 When Success | |
amt | N | 12 | Transaction Amount | 1000 When Success |
notaxAmt | N | 12 | Tax Fee Amount | 0 When Success |
vat | N | 12 | Value Added Tax (VAT) | 0 When Success |
fee | N | 12 | Service Fee | 0 When Success |
currency | A | 3 | Currency | IDR When Success |
goodsNm | AN | 100 | Goods Name | Goods+For+Testing+Pre+-+Auth+Token When Success |
billingNm | A | 100 | Billing Name | John+Doe When Success |
transDt | N | 8 | Transaction Date (YYYYMMDD) | 20221222 When Success |
transTm | N | 6 | Transaction Time (HH24MISS) | 154852 When Success |
authNo | N | 10 | Approval Number | 525731 When Success (Additional) |
issuBankCd | A | 4 | CENA When Success | |
acquBankCd | A | 44 | BMRI When Success | |
issuBankNm | A | 255 | Issuing Bank Name | BCA When Success |
acquBankNm | A | 255 | Acquiring Bank Name | Mandiri When Success |
ccTransType | AN | 2 | 1 When Success | |
cardNo | ANS | 20 | Card Number With Masking | 53079511****1111 When Success |
cardExpYymm | N | 4 | Card Expiry (YYMM) | 2712 When Success |
instmntType | N | 2 | 1 When Success | |
instmntMon | N | 2 | Installment Month 1: 1 Month/Full Payment, jika instmntType: null/1 3: 3 Months 6: 6 Months 12: 12 Months | 1 When Success |
recurringToken | AN | 255 | Recurring Token | null When Success |
preauthToken | AN | 255 | Pre-Auth Token | edc46eb30a81ac9753e34003d2d1e910d5aaf0dea620889dffcfcc18621864eb When Success |
matchCl | N | 1 | Payment Amount Match Flag: | 1 When Success |
merchantToken | AN | 255 | Merchant Token | 1bee4b7c84cfb4e04d9d26cd47285bf49a77f252f39a48370094f5e3250b9524 |
Setelah melakukan registrasi dan pembayaran menggunakan Checkout API,
- Jika ingin melakukan multiple capture dengan menggunakan Pre-Auth Token yang sama, silakan melakukan registrasi kembali.
- Kemudian melakukan Capture pada Payment V2 Credit Card dengan menambahkan Pre-Auth Token pada parameter preauthToken beserta memasukkan CVV.
tXid tidak akan sama dengan request hold. Proses Capture akan memastikan bahwa nilai amount yang di-capture tidak melebihi dana yang dimiliki.
Saat Callback diterima callbackUrl Anda, kami merekomendasikan Merchant untuk melakukan verifikasi Status dengan menggunakan Status Inquiry - API Checkout.
CallBack Handling sangat penting untuk membantu meminimalisir tindakan Fraud. Kami sangat merekomendasikan Merchant untuk melakukan verifikasi menggunakan CallBack parameter.
![Alur CallBack Handling Alur CallBack Handling](https://images.archbee.com/ZHvSjR5ZrsoxwKbJa3xmo/ccwlMZjgo0gOioQqjK2oO_nicepay-api-checkout-api-callback-handling-flow-1.png?format=webp)