# List Balance Transfers

Retrieve a list of all  objects.

For details on how to query endpoints using the available parameters, see Query Parameters.

Endpoint: GET /balance_transfers
Version: 2022-02-01
Security: BasicAuth

## Query parameters:

  - `limit` (integer)
    The numbers of items to return.
    Example: 3

  - `pageNumber` (integer)
    The page number to list.

  - `pageSize` (integer)
    The size of the page.

  - `created_at.gte` (string)
    Filter where  is after the given date.
    Example: "2022-09-27T11:21:23"

  - `created_at.lte` (string)
    Filter where  is before the given date.
    Example: "2026-09-27T11:21:23"

  - `updated_at.gte` (string)
    Filter where  is after the given date.
    Example: "2022-09-27T11:21:23"

  - `updated_at.lte` (string)
    Filter where  is before the given date.
    Example: "2026-09-27T11:21:23"

  - `idempotency_id` (string)
    Filter by Idempotency ID.
    Example: "15d32948-c766-4033-8d87-dfbdcabcbc5c"

  - `amount` (integer)
    Filter by an amount equal to the given value.
    Example: 100

  - `description` (string)
    Filter by the  value .

  - `destination` (string)
    Filter by the  saved in .

  - `external_reference_id` (string)
    Filter by the value saved in .

  - `reference_id` (string)
    Filter by the value saved in .

  - `source` (string)
    Filter by the  saved in .

## Response 200 fields (application/json):

  - `page` (object)
    Details the page that's returned.

  - `page.count` (integer)
    The number of entries returned.

  - `page.limit` (integer)
    The number of entries to return.

  - `page.offset` (integer)
    The number of items to skip before starting to collect the result set.

  - `_embedded` (object)
    List of  objects.

  - `_embedded.balance_transfers` (array)
    objects.

  - `_links` (object)
    For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these  to make your follow-up requests and quickly access relevant IDs.

  - `_links.next` (object)
    Link to the next page of entries.

  - `_links.next.href` (string)

  - `_links.self` (object)
    Link to the resource that was used in the request.

## Response 400 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors.code` (string)
    Enum: "UNPROCESSABLE_ENTITY"

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

## Response 401 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "UNKNOWN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.self` (object)

  - `_embedded.errors._links.self.href` (string)

  - `_embedded.errors._links.source` (object)

## Response 403 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "FORBIDDEN"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)

## Response 406 fields (application/json):

  - `total` (integer)

  - `_embedded` (object)

  - `_embedded.errors` (array)

  - `_embedded.errors.code` (string)
    Enum: "NOT_FOUND"

  - `_embedded.errors.logref` (object)

  - `_embedded.errors.message` (string)

  - `_embedded.errors._links` (object)

  - `_embedded.errors._links.source` (object)

  - `_embedded.errors._links.source.href` (string)