API
Ledger / Disbursement History
Use the Ledger / Disbursement History endpoint to retrieve Send Money transactions for a selected date range and status filter. Finance and operations teams can use this data to reconcile payouts, investigate pending or failed transfers, and compare Brick transaction records with internal ledgers or reports.
Environment for Endpoint URL
Please Replace the environment in the URL with:
When the environment is sandbox, replace the
{environment}with sandbox. so the URL will be https://sandbox.onebrick.io/v2/payments/gsWhen the environment is production, replace the
{environment}with api. so the URL will be https://api.onebrick.io/v2/payments/gs
Request parameters
| Key Parameters | Data Type | Description |
|---|---|---|
| publicAccessToken | String | One time access-token generated using the auth token API |
| startDate | Date | Start date based on transaction created date. Format is YYYY-MM-DD |
| endDate | Date | End date based on transaction created date. Format is YYYY-MM-DD |
| status | String | completed or processing or pending or failed |
| search | String | Look for specific transaction ID or referenceId |
| page | Integer | Which page of the data should be retrieved |
| size | Integer | How many records need to be retrieved per page. Maximum record is 2000 & default is 100 per page |
Response parameters
| Key Parameters | Data type | Description |
|---|---|---|
| refId | String | Reference ID given by end user |
| date | Timestamp | Transaction created date |
| accountHolderName | String | Beneficiary Account holder name |
| accountNumber | Integer | Beneficiary Account number |
| bankName | String | Beneficiary bank name |
| description | String | Description that filled related to fund transfer |
| amount | Big Decimal | Transaction amount |
| fees | Big Decimal | Fees applied to Transaction |
| status | String | Status of the transaction. either completed or processing or pending or failed |
Last modified on