Skip to main content
GET
Get all transfers for a given account

Filters

You can narrow results by appending query parameters. All filters use exact match and are case-sensitive. When you combine multiple filters they apply with AND semantics — only transfers matching every supplied filter are returned. If no transfers match the filters, the API returns 200 with an empty transfers array and a pagination object.
value_type and transfer_type use canonical API identifiers. See Value types and Transfer types for the full list of valid values.

Filtering by transaction_id

Pass the full on-chain transaction hash or off-chain payment reference to find transfers that match on either the source or destination leg. The filter is exact match and case-sensitive. If no transfer matches, the API returns 200 with an empty transfers array. You can combine transaction_id with other filters — multiple filters use AND semantics.

Pagination

Only one of page[after] or page[prev] may be present per request. Filters persist across pages — you do not need to resend them when paging. Use the pagination.next value from the previous response as the page[after] query parameter in the next request.

Examples

Filter by transaction_id

Filter by automation_id

Filter by value_type

Filter by transfer_type

Combined filters

Return only Polygon USDC transfers created by a specific Automation, 10 per page:

Response schema

A successful response returns 200 with the following structure:
Response

source.payment_details

source.payment_details appears when Brale has underlying payment metadata to expose for the source leg of a transfer. This is primarily relevant for inbound fiat-funded transfers. The object is optional and is not present on all transfers. Wire transfers typically include the full set of fields. ACH transfers may include only a subset — fields may be null or omitted depending on available rail metadata. See Transfers — source.payment_details for full details.

destination.payment_details

destination.payment_details appears when Brale has underlying payment metadata to expose for the destination leg of a transfer. This is primarily relevant for outbound wire transfers. The object is optional and may be absent immediately after a transfer is created; for outbound wires, Brale populates it later once the IMAD is available from the sending bank. See Transfers — destination.payment_details for full details.

Authorizations

Authorization
string
header
required

Use the Bearer token returned from the Auth endpoint via OAuth2 client_credentials flow. Include the token in the "Authorization: Bearer " header.

Path Parameters

account_id
string<ksuid>
required

The ID of the account

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

Query Parameters

automation_id
string<ksuid>

Filter transfers to only those created by the specified Automation. Must be a valid KSUID. Exact match.

Pattern: ^[a-zA-Z0-9]{26}$
Example:

"2VcUIIsgARwVbEGlIYbhg6fGG57"

value_type
string

Filter transfers by currency or token identifier. Matches transfers where the source or destination value_type equals this value. Case-sensitive. Use canonical API ids from the Coverage page.

transfer_type
string

Filter transfers by payment rail or chain identifier. Matches transfers where the source or destination transfer_type equals this value. Case-sensitive. Use canonical API ids from the Coverage page.

transaction_id
string

Filter transfers by on-chain transaction hash or off-chain payment reference. Exact match against the transaction_id field on either the source or destination leg.

page[size]
integer

The number of transfers to return per page (1–100, default 25).

Required range: 1 <= x <= 100
page[next]
string

Cursor for the next page (value returned in pagination.next)

page[prev]
string

Cursor for the previous page (value returned in pagination.prev)

Response

200 - */*

A list of transfers with pagination cursors

List of transfers plus pagination cursors

pagination
Pagination · object
required

Cursor-based pagination metadata

transfers
Transfer · object[]
required