Regular Disbursement
Use the Regular Disbursement endpoint to create Send Money payouts through Brick's RTOL-like regular routing flow. This endpoint is useful when your destination, transaction amount, or pricing setup fits the Regular route, and when your business needs to automate bank account or supported Ewallet payouts, store a client referenceId, and confirm the final result through status checks or disbursement callbacks.
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. |
Testing in Sandbox Environment (Testing Mode)
To simulate various transaction statuses, use the sample inputs below when calling the Disbursement API in the sandbox environment:
Regular Disbursement
| Bank Short Code | Bank Account Number | Bank Account Holder Name | Amount | Expected Status |
|---|---|---|---|---|
| MANDIRI | 112233445 | PROD ONLY | Rp29.999 | Completed |
| BRI | 112233445 | PROD ONLY | Rp10.000 - Rp500.000.000 | Processing |
| MANDIRI | 112233445 | PROD ONLY | Rp39.999 | Failed |
| SINARMAS | 112233445 | PROD ONLY | Rp10.000 - Rp500.000.000 | Failed with error 503 (Bank Under Maintenance) |
Important Notes for Sandbox Testing:
- Bank Account Number: Any number with more than 8 digits is acceptable.
- Account Holder Name: Must always be exactly "PROD ONLY".
- Amount: Must fall within the range of Rp10.000 to Rp500.000.000.
- These values are hardcoded in our sandbox environment to help simulate specific response statuses.
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 for the failed transaction. This field is shown only when the transaction fails. |
| amount | String | Amount of money to be disbursed |
| feeAmount | String | Fee of the transaction |
| 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 |
❗️ 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.