Accounts
Get all information about your customer financial institution accounts, including: account type, name, address,phone number,email, account number, currency, balance.
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.
Account APIs
Account APIs help us to provide a list of all connected financial institutions' accounts for requested users and details of those accounts.
| Endpoint | Method | Description |
|---|---|---|
| Account List - GET | GET | The Account List endpoint returns all a list of accounts or products (and their associated data) held by the end-user with a Provider. |
| Account List - POST | POST | This endpoint can be used to refresh the session of institution with MFA by sending new OTP to end user. Currently, E-Wallet can use this customization. |
| Account List - PATCH MFA | PATCH | This endpoint can be used to retrieve latest list of accounts or products (and their associated data) held by the end-user with a Provider by providing new OTP to refresh the account session. Currently, E-Wallet can use this customization. |
| Account Detail | GET | This endpoint can be used to retrieve data associated with the specified ‘account_id’. |
| Account Detail - POST MFA | POST | This endpoint can be used to refresh the session of institution with MFA by sending new OTP to end user. Currently, E-Wallet can use this customization. |
| Account Detail - PATCH MFA | PATCH | This endpoint can be used to retrieve data associated with the specified ‘account_id’ by providing new OTP to refresh the account session. Currently, E-Wallet can use this customization. |
We also offer an OCR-based Digitisation of Financial statements images/documents product. which can be used to parse any institution's PDF/image statement and get a structured JSON representation of this statement. If you want to know more about this endpoint, contact us via.
Account Number Verification API
Account number verification API helps us to verify the beneficiary accounts, So we can prevent ourselves from sending amounts to incorrect accounts.
Please see codes & destination for a full list of accounts you can send to.
Checking real account need to use on Production Environment
Account Number verification API by default returns dummy value in the Sandbox environment. Please reach via, If you want to test with real data.
| Endpoint | Method | Description |
|---|---|---|
| Account Verification API | POST | This endpoint can be used to check the validity of the account. |
Updated 11 months ago