Welcome to the Brick API references. You will find comprehensive guides and details about APIs here.
If you have not created the account till now, Please feel free to create it from here.
Our new version of APIs(v2) is callback-based APIs, So if you have not set up a callback URL till now, Please set it from brick dashboard.
We have multiple callbacks for different APIs, Clients have to set different callback URLs. Please find the details below.
| APIs | Callback URL |
|---|---|
| Payment Disbursement APIs | Disbursement Callback URL |
| Virtual Account APIs | Virtual Account Callback URL |
In every API response, You will get a few common fields, Please find the details about keys and use-case below.
| Keys | Use case |
|---|---|
| status | HTTP/HTTPS status code |
| message | Text message |
| job_id | Unique transaction_id, It will help to map Async response |
| source | It defines from where APIs request is coming, It can be either one from API, Widget, Dashabord, SDK or Portal. |
| entity | It defines which product the APIs request is coming from, It can be either one from Data, Insight, Verification, or Payments. |
Please check the complete details for API responses here.