Regular Disbursement

Sending funds via Brick allows you to perform digital fund transfers, and Brick currently supports fund transfers to financial accounts and e-wallets. Before you can send out funds, you will need to make sure that there are sufficient funds in your account with Brick for disbursements to be possible. To do that, deposit funds to your Brick account.

Before using this API, it is suggested to use Account Verification API to validate the recipient's account.

Request parameters

Key ParametersData TypeDescription
publicAccessTokenStringOne time access-token generated using the auth token API
referenceIdStringA unique reference ID as a unique identifier
amountIntegerAmount of money to be disbursed
recipientEmailStringEmail of the transfer recipient. System will send email and PDF transfer proof to this email.
descriptionStringAn arbitrary string attached to the object. Often useful for displaying to users what the transaction was for. Description length limit is 255 chars.
typeStringCurrently only support bank transfer
bankAccountNoStringAccount number of the recipient user
bankShortCodeStringInstitution short code of the recipient user bank account
bankAccountHolderNameStringAccount name that the funds are intended to be sent to.

Response parameters

Key ParametersData typeDescription
idStringUnique identifier
typeStringType of transaction
statusStringThe status of disbursement
createdAtTimeStampTime at which the response was created.
failureReasonStringReason of failed transaction and will only be shown when the transaction is failed.
amountStringAmount of money to be disbursed
feeAmountStringFee of the transaction
referenceIdStringA unique reference ID as a unique identifier
descriptionStringAn arbitrary string attached to the object. Often useful for displaying to users what the transaction was for. Description length limit is 255 chars.
disbursementMethodTypeStringCurrently only support bank transfer
bankAccountNoStringAccount number of the user
bankShortCodeStringInstitution short code of the user
bankAccountHolderNameStringAccount name that the funds are intended to be sent to.
bankNameStringName of the Institutions
settlementStatusStringStatus of Transaction Settlement

❗️

Important Note on API Responses

If your system does not receive an HTTP 200 response with a valid transaction status (PROCESSING, COMPLETED, or FAILED), you must not flag the transaction as succeeded or failed.

A non-200 response (e.g., timeout, 5xx error, or no response) means the outcome is uncertain, and you should treat the transaction as pending until you confirm its status via the Status API.

Language
Credentials
Header
Click Try It! to start a request and see the response here!