Brick API Documentation
Brick
Brick API

Bank Account Validation

Server

Verifikasi detail rekening bank Indonesia sebelum menyimpan penerima atau memulai pembayaran. Validasi rekening mengurangi transfer gagal, nomor rekening salah ketik, dan masalah rekonsiliasi operasional.

Client Reference

clientReference adalah query parameter opsional yang dapat ditentukan oleh client sebagai custom unique reference untuk setiap request Bank Account Validation. Gunakan field ini untuk mempermudah tracking, matching transaksi, dan proses rekonsiliasi menggunakan reference internal milik client sendiri.

Nilai yang didukung: alphanumeric, hyphen (-), underscore (_), dan period (.), maksimal 64 karakter. clientReference kosong diperlakukan sama seperti tidak dikirim. Jika client yang sama mengirim clientReference duplikat, Brick mengembalikan 409 duplicate_reference.

Request tanpa clientReference

Code
GET https://api.onebrick.io/v2/payments/gs/bank-account-validation?accountNumber=<ACCOUNT_NUMBER>&bankShortCode=BCA_SYR Headers: Accept: application/json Content-Type: application/json publicAccessToken: Bearer <token>

Response tanpa clientReference

JSONCode
{ "status": 200, "data": { "message": "Bank account validation has been completed successfully, and the submitted account details have been verified.", "bankShortCode": "BCA_SYR", "accountNo": "<ACCOUNT_NUMBER>", "accountName": "<ACCOUNT_NAME>", "activityId": "7b63f490900376f0f60aab63afde17d5" }, "error": null, "metaData": { "source": "API", "entity": "Payment" } }

Request dengan clientReference

Code
GET https://api.onebrick.io/v2/payments/gs/bank-account-validation?accountNumber=<ACCOUNT_NUMBER>&bankShortCode=BCA_SYR&clientReference=BAV_TEST-001 Headers: Accept: application/json Content-Type: application/json publicAccessToken: Bearer <token>

Response dengan clientReference

JSONCode
{ "status": 200, "data": { "message": "Bank account validation has been completed successfully, and the submitted account details have been verified.", "bankShortCode": "BCA_SYR", "accountNo": "<ACCOUNT_NUMBER>", "accountName": "<ACCOUNT_NAME>", "activityId": "a7014608c43969d890ea0fbf1cfc493e", "clientReference": "BAV_TEST-001" }, "error": null, "metaData": { "source": "API", "entity": "Payment" } }

Response duplicate clientReference

JSONCode
{ "status": 409, "data": null, "error": { "code": "duplicate_reference", "message": "clientReference has already been used.", "action": "Please use a unique clientReference for each Bank Account Validation request.", "reason": "The provided clientReference already exists." }, "metaData": { "source": "API", "entity": "Payment" } }

API Verifikasi Rekening

GET
https://sandbox.onebrick.io
/v2/payments/gs/bank-account-validation
publicAccessToken (header)

Verifikasi detail rekening bank sebelum menyimpan penerima, melakukan orientasi pengguna, atau memulai pembayaran. Gunakan endpoint ini sebagai Financial Insight atau pemeriksaan pengendalian risiko untuk mengurangi kegagalan terkait kesalahan ketik dan penggunaan akun yang mencurigakan. Responsnya membantu sistem Anda memutuskan apakah data akun cukup valid untuk melanjutkan alur kerja.

API Verifikasi Rekening › query Parameters

accountNumber
​string · required

Nomor rekening bank yang akan diverifikasi.

Default:
bankShortCode
​string · required

Kode pendek bank yang akan divalidasi. Contoh collection: MANDIRI.

Default:
clientReference
​string · maxLength: 64 · pattern: ^[A-Za-z0-9._-]*$

Referensi unik opsional dari sistem client untuk tracking, pencocokan transaksi, dan rekonsiliasi. Gunakan maksimal 64 karakter: huruf, angka, tanda hubung (-), underscore (_), atau titik (.). Kosongkan atau hilangkan parameter ini jika tidak ingin mengirim client reference.

Default:

API Verifikasi Rekening › Responses

200 Sukses

oneOf
Exactly one variant must match.

Decision Table

VariantMatching Criteria
type = object
type = object
Properties for Success:
status
​integer
​object
error
​
​object