get
https://sandbox.onebrick.io/v2/payments/gs/disbursements/proof//download
Allows you to retrieve proof of transfer documents through API integration. Limited to a maximum of 5 requests per hour.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this endpoint to download the proof-of-transfer document for a completed disbursement.
The transfer proof is returned as a PDF file and can be used for customer support, reconciliation, or internal audit records. This endpoint is rate limited to a maximum of 5 requests per hour, so cache or store the downloaded proof when your system needs repeated access.
Before You Call This Endpoint
- Make sure the disbursement has reached a final status that supports transfer proof generation.
- Use the disbursement ID returned by the Create Disbursement API or status API.
- Avoid polling this endpoint; use it only when the proof document is needed.
Request Parameter (Path Parameter)
| Parameter | Data Type | Description |
|---|---|---|
| disbursementId | String | The unique identifier of the disbursement transaction you want to download. You can obtain this ID from the response body of the Create Disbursement API. |
Response Body
| Parameter | Data Type | Description |
|---|---|---|
| proof | File | In pdf format |