FIfinix
Balances

Fetch a Balance Entry

Changed on

Retrieve the details of a specific Balance Entry.

get/balance_entries/{balance_entry_id}

Request

Headers

Finix-Versionstring
Example:2022-02-01

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

Response

A single Balance

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

amountinteger

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

created_bystring

The ID of the application user that created this Balance Adjustment.

currency'CAD' | 'USD'

ISO 4217 3-letter currency code.

descriptionstring nullable

A description of the Balance Entry.

entity_idstring

The ID of the resource that caused the change to the Balance, either a Balance Adjustment (i.e., "top-up") or a Transfer.

entity_type'BALANCE_ADJUSTMENT' | 'TRANSFER'

The resource type that caused the change to the Balance.

estimated_posted_datestring date-time

Timestamp estimating when the Balance Entry will be posted (i.e., the state is set to SUCCEEDED).

linked_tostring

The ID of the resource (e.g., an Application) that the Balance Entry is linked to.

linked_type'APPLICATION'

Specifies the type of resource identified in linked_to.

parent_balance_entry_idstring nullable

The parent_balance_entry_id refers to the ID of the original Balance Entry. This is only applicable for transactions that have been reversed after being posted (i.e., the state is set to RETURNED). For instance, if a transaction with the ID balance_entry_xyz is reversed, the newly created reversal entry will have a parent_balance_entry_id that matches the ID of the original transaction, balance_entry_xyz.

posted_atstring date-time nullable

Timestamp of when the Balance Entry was posted and finalized on the Balance (i.e., state changed to SUCCEEDED). This field is null if the entry has not been posted.

state'SUCCEEDED' | 'PENDING' | 'FAILED' | 'RETURNED'

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.
tagsTags 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)
transaction_datestring date-time nullable

The date of the transaction.

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

The transaction type that caused a change to the Balance.

Example response

{
  "amount": 5000
}

Changes

  • 1d6b546b10f2Revision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      removed the optional property / from the response with the status

    • info

      added the optional property to the response with the status