Brick API Documentation
Brick

BI-FAST Pencairan API

Pencairan BI-FAST API adalah titik akhir Brick Kirim Uang untuk membuat pembayaran transfer bank melalui jaringan BI-FAST. Gunakan API ini ketika bank penerima memenuhi syarat untuk BI-FAST dan jumlah transaksi Anda sesuai dengan persyaratan transfer BI-FAST untuk akun Anda.

Permintaan pencairan BI-FAST mencakup jumlah pembayaran, referenceId unik Anda, rincian rekening bank penerima, dan informasi pengirim yang diperlukan untuk pemrosesan BI-FAST. Setelah membuat permintaan, lacak hasil akhir melalui callback atau titik akhir status alih-alih hanya mengandalkan respons awal API.

Kapan Menggunakan Pencairan BI-FAST

Gunakan Pencairan BI-FAST ketika:

  • bank tujuan didukung untuk BI-FAST;
  • jumlah pembayaran berada dalam batas BI-FAST yang berlaku;
  • integrasi Anda dapat memberikan identitas pengirim, alamat, dan informasi pekerjaan yang diperlukan; dan
  • sistem Anda dapat menangani pembaruan status asinkron melalui panggilan balik atau pemeriksaan status.

Parameter permintaan

Parameter UtamaTipe DataDeskripsi
publicAccessTokenTaliToken akses satu kali dibuat menggunakan token autentikasi API
referensiIdTaliID referensi unik sebagai pengidentifikasi unik
jumlahbilangan bulatJumlah uang yang akan dicairkan
penerimaEmailTaliEmail penerima transfer. Sistem akan mengirimkan email dan bukti transfer PDF ke email ini.
deskripsiTaliString sembarang yang melekat pada objek. Seringkali berguna untuk menampilkan kepada pengguna tujuan transaksi tersebut. Batas panjang deskripsi adalah 255 karakter.
mengetikTaliSaat ini hanya mendukung "bank_transfer"
Rekening bankNoTaliNomor akun pengguna penerima
bankShortCodeTaliKode pendek institusi dari rekening bank pengguna penerima
bankAccountHolderNameTaliNama rekening tujuan pengiriman dana.

Parameter Permintaan Tambahan untuk BI-FAST

Parameter UtamaTipe DataDeskripsiBatasan
namaTaliNama pengguna yang mengirim uang1. Alfa Numerik 2. Spasi Dibolehkan 3. Maks 40 Karakter
tipe identitasTaliNilai yang diperbolehkan hanya KTP/SIM/KITAS/NPWPNilai yang diperbolehkan hanya KTP/SIM/KITAS/NPWP
nomor identitasTaliNomor Identitas Pengguna1. Alfa Numerik 2. Min 10 karakter 3. Maks 16 Karakter
Kode negaraTaliKode negara dua huruf untuk pengirimNilai yang diperbolehkan: 2 karakter huruf besar
kode provinsiTaliKode provinsi dua huruf untuk pengirimNilai yang diperbolehkan: 2 karakter huruf besar
kode kotaTaliKode kota empat huruf untuk pengirimNilai yang diperbolehkan: 4 karakter huruf besar
kode pekerjaanTaliKode pekerjaan empat huruf untuk pengirimNilai yang diperbolehkan: 4 karakter huruf besar
alamatTaliAlamat pengguna1. Alfa Numerik 2. Spasi Dibolehkan 3. Maks 40 Karakter
tempat lahirTaliTempat lahir pengguna1. Alfa Numerik 2. Spasi diperbolehkan 3. Maks 40 Karakter
tanggal lahirTaliTanggal Lahir penggunaFormat YYYY-MM-DD

Pengujian di Lingkungan Sandbox (Mode Testing)

Untuk mensimulasikan berbagai status transaksi, gunakan input contoh di bawah saat memanggil Disbursement API di lingkungan sandbox:

Pencairan BI-Fast

Kode Pendek BankNomor Rekening BankNama Pemilik Rekening BankJumlahStatus yang Diharapkan
BCA010800041187JOHN CENARp10.000 - Rp250.000.000Completed
BCA7095560835JOHN CENARp10.000 - Rp250.000.000Processing

Catatan Penting untuk Pengujian Sandbox:

  • Jumlah: Harus berada dalam rentang Rp10.000 hingga Rp250.000.000.

Parameter respons

Parameter UtamaTipe dataDeskripsi
idTaliPengidentifikasi unik
mengetikTaliJenis transaksi
statusTaliStatus pencairan
dibuatPadaStempel WaktuWaktu saat respons dibuat.
kegagalanAlasanTaliAlasan transaksi gagal. Bidang ini hanya ditampilkan ketika transaksi gagal.
jumlahTaliJumlah uang yang akan dicairkan
jumlah biayaTaliBiaya transaksi
referensiIdTaliID referensi unik sebagai pengidentifikasi unik
deskripsiTaliString sembarang yang melekat pada objek. Seringkali berguna untuk menampilkan kepada pengguna tujuan transaksi tersebut. Batas panjang deskripsi adalah 255 karakter.
pencairanMethodTypeTaliSaat ini hanya mendukung transfer bank
Rekening bankNoTaliNomor akun pengguna
bankShortCodeTaliKode pendek institusi pengguna
bankAccountHolderNameTaliNama rekening tujuan pengiriman dana.
Nama bankTaliNama Institusi
status penyelesaianTaliStatus Penyelesaian Transaksi

Parameter Respons Tambahan untuk BI-FAST

Parameter UtamaTipe DataDeskripsi
namaTaliNama pengguna yang mengirim uang
tipe identitasTaliNilai yang diperbolehkan hanya KTP/SIM/KITAS/NPWP
nomor identitasTaliNomor Identitas Pengguna
Kode negaraTaliKode Negara berdasarkan pengguna
kode provinsiTaliKode Provinsi berdasarkan pengguna
kode kotaTaliKode Kota berdasarkan pengguna
kode pekerjaanTaliKode Pekerjaan berdasarkan pengguna
alamatTaliAlamat pengguna
tempat lahirTaliTempat lahir pengguna
tanggal lahirTaliTanggal Lahir pengguna

❗️ Catatan Penting tentang Respons API

Jika sistem Anda tidak menerima respons HTTP 200 dengan status transaksi yang valid (PROCESSING, COMPLETED, atau FAILED), Anda tidak boleh menandai transaksi tersebut sebagai berhasil atau gagal.

Respons non-200 (misalnya, batas waktu, kesalahan 5xx, atau tidak ada respons) berarti hasilnya tidak pasti, dan Anda harus menganggap transaksi tersebut tertunda hingga Anda mengonfirmasi statusnya melalui Status API.

Last modified on