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
amountStringAmount of money to be disbursed
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.
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.
amountIntegerAmount of money to be disbursed
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
Language
Click Try It! to start a request and see the response here!