FIfinix
Balances

List Balance Entries

Changed on

A Balance Entry reflects a change to an application's Balance due to a Transfer or a Balance Adjustment (i.e., "top-up").

You can use this endpoint to obtain a list of Balance Entry objects.

get/balances/{balance_id}/balance_entries

Request

Query parameters

after_cursorstring

Return every resource created after the cursor value.

amountinteger
Example:100

Filter by an amount equal to the given value.

amount.gtinteger
Example:100

Filter by an amount greater than.

amount.gteinteger
Example:100

Filter by an amount greater than or equal.

amount.ltinteger
Example:100

Filter by an amount less than.

amount.lteinteger
Example:100

Filter by an amount less than or equal.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

entity_idstring
Example:TR2vw93rwm6LkH1MES6T9uYe

Return the Balance Entry triggered by the given Transfer or Balance Adjustment ID.

entity_type'BALANCE_ADJUSTMENT' | 'TRANSFER'

Filter Balance Entries by whether they were triggered by a TRANSFER or a BALANCE_ADJUSTMENT.

idstring
Example:balance_entry_7s6EstknMq5KekMooedkES

Retrieve a Balance Entry by its id.

limitinteger
Example:10

The numbers of items to return.

parent_balance_entry_idstring
Example:balance_entry_xxx

Return the reversal Balance Entry for the given original Balance Entry ID. When a posted entry is reversed, a new entry with state set to RETURNED is created with its parent_balance_entry_id set to the original entry's ID.

posted_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter Balance Entries posted and finalized on the Balance on or after the given date.

posted_at.ltestring date-time
Example:2022-09-27T11:21:23

Filter Balance Entries posted and finalized on the Balance on or before the given date.

state'FAILED' | 'PENDING' | 'RETURNED' | 'SUCCEEDED'
Example:SUCCEEDED

Filter by the current state of the Balance Entry:

  • SUCCEEDED: The Balance Entry has been successfully posted and affects the account balance.
  • PENDING: The Balance Entry is awaiting confirmation and has not yet affected the account balance.
  • FAILED: The Balance Entry failed and did not affect the account balance.
  • RETURNED: The Balance Entry was returned (e.g., due to an ACH return) and has been reversed.
tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

type'BALANCE_TOP_UP_ACH' | 'BALANCE_WITHDRAWAL_ACH' | 'MANUAL_BALANCE_ADJUSTMENT_DECREASE' | 'MANUAL_BALANCE_ADJUSTMENT_INCREASE' | 'PULL_FROM_ACH' | 'PULL_FROM_CARD' | 'PULL_FROM_SAME_DAY_ACH' | 'PUSH_TO_ACH' | 'PUSH_TO_CARD' | 'PUSH_TO_SAME_DAY_ACH'

Filter by the transaction type that caused a change to the Balance.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Balance resources

Changes

  • 580b8253caceRevision changes
    • info

      added the new optional query request parameter amount

    • info

      added the new optional query request parameter amount.gt

    • info

      added the new optional query request parameter amount.gte

    • info

      added the new optional query request parameter amount.lt

    • info

      added the new optional query request parameter amount.lte

    • info

      added the new optional query request parameter entity_id

    • info

      added the new optional query request parameter entity_type

    • info

      added the new optional query request parameter id

    • info

      added the new optional query request parameter parent_balance_entry_id

    • info

      added the new optional query request parameter posted_at.gte

    • info

      added the new optional query request parameter posted_at.lte

    • info

      added the new optional query request parameter state

    • info

      added the new optional query request parameter type