BRICKFAST - Disbursement
Regular Disbursement Callback
The Disbursement callback will return the transaction information with updated status information.
Code
Code
Please note when you setup your callback endpoint :
- Callback method : POST
- Content type : app/json
- Add whitelist to Brick server for secure connection
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. |
| amount | Integer | 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 the transaction |
| errorCode | String | A unique identifier representing the error that occurred during the transaction. See how to handle errors here. |
| errorReason | String | A brief explanation of the error that caused the transaction failure. |
| errorDetail | JSON Object | A detailed breakdown of the error, including specific information on the cause and possible resolution steps. |
Additional Response Parameters:
errorDetail (JSON object)
| Key Parameters | Data Type | Description |
|---|---|---|
| code | String | A machine-readable error code categorizing the error. |
| message | String | A human-readable error message describing the issue. |
| action | String | Suggested actions that can be taken to resolve the error. |
| reason | String | Additional context explaining why the error occurred. |
Last modified on
