post https://sandbox.onebrick.io/v2/payments/gs/disbursements
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 Parameters | Data Type | Description |
|---|---|---|
| publicAccessToken | String | One time access-token generated using the auth token API |
| referenceId | String | A unique reference ID as a unique identifier |
| amount | Integer | Amount of money to be disbursed |
| recipientEmail | String | Email of the transfer recipient. System will send email and PDF transfer proof to this email. |
| description | String | An arbitrary string attached to the object. Often useful for displaying to users what the transaction was for. Description length limit is 255 chars. |
| type | String | Currently only support bank transfer |
| bankAccountNo | String | Account number of the recipient user |
| bankShortCode | String | Institution short code of the recipient user bank account |
| bankAccountHolderName | String | Account name that the funds are intended to be sent to. |
Response parameters
| Key Parameters | Data type | Description |
|---|---|---|
| id | String | Unique identifier |
| type | String | Type of transaction |
| status | String | The status of disbursement |
| createdAt | TimeStamp | Time at which the response was created. |
| failureReason | String | Reason of failed transaction and will only be shown when the transaction is failed. |
| amount | String | Amount of money to be disbursed |
| referenceId | String | A unique reference ID as a unique identifier |
| description | String | An arbitrary string attached to the object. Often useful for displaying to users what the transaction was for. Description length limit is 255 chars. |
| disbursementMethodType | String | Currently only support bank transfer |
| bankAccountNo | String | Account number of the user |
| bankShortCode | String | Institution short code of the user |
| bankAccountHolderName | String | Account name that the funds are intended to be sent to. |
| bankName | String | Name of the Institutions |
| settlementStatus | String | Status of Transaction Settlement |