Brick API Documentation
Brick

Mulai Cepat untuk Pencairan API

Sebelum Anda mulai:

  1. Tinjau Prepare Yourself to Use API sebelum memulai integrasi.
  2. Anda dapat menguji API menggunakan Try Brick API with Postman.

Buat Pencairan Pertama Anda

Untuk memulai cepat ini, gunakan metode pencairan reguler. Brick mendukung dua metode pencairan: Reguler dan BI-FAST.

1. Hasilkan token akses publik - API reference

Token akses publik adalah token autentikasi yang digunakan dalam panggilan API lebih lanjut untuk Kirim Uang dan Terima Uang APIs. Token akses publik ini dibuat menggunakan kredensial API Client ID dan Client Secret yang Anda dapatkan dari bagian persiapan.

📘 Batasan token akses publik

API ini memberikan Anda token akses publik yang hanya valid digunakan 1 kali dan hanya untuk 5 menit berikutnya. Jika masa berlakunya habis, Anda perlu membuat token akses publik baru.

2. Verifikasi akun penerima - API reference

Verifikasi akun penerima sebelum membuat pencairan. Hal ini membantu mencegah kegagalan yang disebabkan oleh kode bank yang tidak valid, nomor rekening yang tidak valid, atau detail pemegang rekening yang tidak cocok.

📘 Cantumkan Rekening Bank Tujuan

Jika Anda perlu memeriksa tujuan pembayaran mana yang dicakup oleh Brick, lihat Disbursement Coverage. Brick saat ini memverifikasi tujuan rekening bank, bukan tujuan Ewallet.

3. Buat pencairan - Regular API reference

Gunakan titik akhir ini untuk mengirim uang ke rekening penerima. Hasilkan token akses publik baru seperti yang dijelaskan pada langkah 1, lalu gunakan token baru untuk panggilan pencairan API.

Anda perlu memberikan rincian pembayaran dan penerima. Contoh di bawah ini menunjukkan struktur permintaan dasar:

Code
curl --request POST \ --url https://sandbox.onebrick.io/v2/payments/gs/disbursements \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --header 'publicAccessToken: Bearer {{publicAccessToken}}' \ --data ' { "referenceId": "test-disbursement-1", "description": "test-disbursement-1", "amount": 10000, "disbursementMethod": { "type": "bank_transfer", "bankShortCode": "MANDIRI", "bankAccountNo": "12345678", "bankAccountHolderName": "PROD ONLY" } } '

Jika permintaan valid, respon akan menampilkan status pencairan sebagai processing.

JSONCode
{ "status": 200, "data": { "message": "We have received your request and are processing it, please check your callback URL for transaction status", "id": "asdasd123123asdasdasd", "type": "disbursement", "attributes": { "referenceId": "test-disbursement-1", "description": "test-disbursement-1", "amount": "10000", "status": "processing", "createdAt": "2022-07-21T13:49:39.752+07:00", "disbursementMethod": { "type": "bank_transfer", "bankAccountNo": "12345678", "bankShortCode": "BCA", "bankAccountHolderName": "PROD ONLY" } } }, "metaData": { "source": "API", "entity": "Payment" }, "error": null }

Proses pencairan tergantung bank tujuan. Brick akan mengirimkan status terbaru ke URL panggilan balik yang Anda konfigurasikan.

4. Menerima status panggilan balik

Pencairan biasanya membutuhkan waktu beberapa detik untuk sampai ke rekening bank penerima. Setelah Brick menerima konfirmasi bank bahwa transfer telah selesai, Brick mengirimkan status terbaru ke URL panggilan balik Anda:

JSONCode
{ "data": { "id": "asdasd123123asdasdasd", "type": "disbursement", "attributes": { "referenceId": "test-disbursement-1", "description": "test-disbursement-1", "amount": "10000", "status": "completed", "createdAt": "2022-07-21T13:49:39.752+07:00", "disbursementMethod": { "type": "bank_transfer", "bankAccountNo": "12345678", "bankShortCode": "BCA", "bankAccountHolderName": "PROD ONLY", "bankName" : "Bank Central Asia" } } } }
JSONCode
{ "data": { "id": "9cb8ba6c8aa644ff9a433ace9", "type": "disbursement", "attributes": { "referenceId": "ps-123456", "description": "Good Luck", "amount": "10000", "status": "failed", "settlementStatus": null, "createdAt": "2025-02-12T16:25:11.000+07:00", "errorCode": "5000100", "errorReason": "General Error", "errorDetail": { "code": "general_error", "message": "General Error", "action": "Please try again later or contact support if the issue persists.", "reason": "A general error occurred while processing the request. This may be due to a temporary issue on our end." }, "disbursementMethod": { "type": "bank_transfer", "bankAccountNo": "010800041187", "bankShortCode": "BCA", "bankAccountHolderName": "Bambang Subambang", "bankName": "BCA" } } } }

Anda dapat menangani perilaku tersebut nanti untuk status selesai atau juga memeriksa cara menangani kasus kesalahan.

5. Tayang ke produksi

Setelah Anda menyelesaikan pengembangan dan siap untuk beralih ke produksi, tinjau Production Checklist.

Last modified on