---
title: "List Balance Adjustments"
method: GET
path: "/balance_adjustments"
tags: ["Balance Adjustments"]
---

# List Balance Adjustments

`GET /balance_adjustments`

Retrieve a list of `Balance Adjustment` resources for an `Application`.

Only `ROLE_PARTNER` or `ROLE_PLATFORM` credentials can be used to retrieve `Balance Adjustment` objects.

## Query parameters

- `after_cursor` string
- `before_cursor` string
- `created_at.gte` string, date-time
- `created_at.lte` string, date-time
- `limit` integer
- `tags.key` string
- `tags.value` string
- `updated_at.gte` string, date-time
- `updated_at.lte` string, date-time

## Headers

- `Finix-Version` string

## Response `200`

List of `Balance Adjustment` resources

- object
  - `page` Page — Details the page that's returned.
    - `limit` integer — The number of entries to return.
    - `next_cursor` string, nullable — The cursor to use for the next page of results.
  - `_embedded` object
    - `balance_adjustments` BalanceAdjustment[]
      - `id` string — The ID of the resource.
      - `created_at` string, date-time — Timestamp of when the object was created.
      - `updated_at` string, date-time — Timestamp of when the object was last updated.
      - `amount` integer — The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).
      - `balance_entry_id` string — A ledger record that tracks individual financial movements within a `Balance Adjustment`.
      - `currency` 'USD' — ISO 4217 3 letter currency code.
      - `description` string — A description of the `Balance Adjustment`.
      - `failure_code` string, nullable — The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/payouts/handling-payout-failures).
      - `failure_message` string, nullable — The code of the failure so the decline can be handled programmatically. For more info on how to handle the failure, see [Failure Codes](/guides/payouts/handling-payout-failures).
      - `instrument_id` string — The account, card, or bank account that is credited or debited as part of the adjustment.
      - `processor` 'DUMMY_V1' | 'FINIX_V1' — The payment processing entity responsible for handling transactions, fund movements, etc., between different financial accounts.
      - `rail` 'ACH' — The method of adjustment.
      - `state` 'FAILED' | 'RETURNED' | 'SUBMITTED' | 'SUCCEEDED' — The status of the `Balance Adjustment`, indicating whether the adjustment was successful or failed. - `SUBMITTED` - The balance adjustment has been initiated but is not yet confirmed. - `SUCCEEDED` - The adjustment was successful, and the funds are available. This typically occurs 1-3 business days after `SUBMITTED`. - `FAILED` - Finix was unable to process the adjustment, and the balance was not updated. - `RETURN` - The adjustment was initially successful, but a subsequent return resulted in a reversal of the balance increase.
      - `trace_id` string — A unique identifier for tracking the `Balance Adjustment` across its lifecycle.
      - `type` 'TOP_UP' — Specifies whether the `Balance Adjustment` increases or decreases the account balance. Acceptable values: - `TOP_UP` - Adds funds to the balance (e.g., a deposit or manual funding).
      - `tags` Tags, nullable — Include up to 50 `key: value` pairs to annotate requests with custom metadata. - Maximum character length for individual `keys` is 40. - Maximum character length for individual `values` is 500. (For example, `order_number: 25`, `item_type: produce`, `department: sales`)
      - `_links` object — An object containing link(s) relevant to the request. You can store these links for follow-up requests.
        - `self` object
          - `href` string — The path to the new `Balance Adjustment` resource.
  - `_links` object
    - `self` Self — Link to the resource that was used in the request.
      - `href` string
    - `next` Next — Link to the next page of entries.
      - `href` string

## Other responses

- `401` — Unauthorized. Authentication is required and has failed or has not been provided.
- `403` — Forbidden. The client is authenticated but does not have permission to access the resource.
- `406` — Not Acceptable. The server could not accept the submitted request. Confirm how the request was formatted and submitted.
- `422` — Unprocessable Entity. One or more query parameters were syntactically valid but could not be processed.

---

[API](https://skmtc.net/finix/apis/finix-api-reference.md) · [All operations](https://skmtc.net/finix/apis/finix-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/finix/finix-api-reference/versions/5426f6f99c52/schema)