API
BIFAST Disbursement Callback
BIFAST Disbursement callbacks notify your configured endpoint when a BI-FAST payout status changes. Use this callback payload to update internal payout records, reconcile completed or failed transfers, and keep customer or operations dashboards aligned with Brick's final transaction state.
Code
Code
Please note when you setup your callback endpoint :
- Callback method : POST
- Content type : app/json
- Return HTTP
200only after your system has accepted the callback. Dashboard Test URL / Save & Test also requires a JSON ACK with the exact Brick testreferenceId. - 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:
sender (JSON object)
| Key Parameters | Data Type | Description | Limitation |
|---|---|---|---|
| name | String | Name of the user that send the money | 1. Alpha Numeric 2. Space Allowed 3. Max 40 Characters |
| identityType | String | Allowed Value only KTP/SIM/KITAS/NPWP | Allowed Value only KTP/SIM/KITAS/NPWP |
| identityNumber | String | Identity Number of the User | 1. Alpha Numeric 2. Min 10 characters 3. Max 16 Characters |
| countryCode | String | Two-letter country code for the sender | Allowed value: 2 uppercase characters |
| provinceCode | String | Two-letter province code for the sender | Allowed value: 2 uppercase characters |
| cityCode | String | Four-letter city code for the sender | Allowed value: 4 uppercase characters |
| jobCode | String | Four-letter job code for the sender | Allowed value: 4 uppercase characters |
| address | String | Address of the user | 1. Alpha Numeric 2. Space Allowed 3. Max 40 Characters |
| placeOfBirth | String | Place of the user birth | 1. Alpha Numeric 2. Space allowed 3. Max 40 Characters |
| dateOfBirth | String | Date of Birth of the user | YYYY-MM-DD Format |
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
