FIfinix
Balances

Fetch a Balance

Retrieve the details of an existing Balance.

get/balances/{balance_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.

available_amountinteger

The amount of funds that are currently safe to use or withdraw.

This balance reflects settled funds minus any initiated outflows (such as payouts) that reduce availability immediately, even if they have not yet fully posted.

Funds from incoming transactions (such as top-ups) are not included until they are finalized.

Example:

If the posted balance is $1,000, a $500 payout is initiated, and a $600 top-up is pending, the available_amount is $500.

currency'CAD' | 'USD'

ISO 4217 3-letter currency code.

linked_tostring

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

linked_type'APPLICATION'

Specifies the type of resource identified in linked_to.

pending_amountinteger

The projected balance after all in-flight transactions are finalized.

This amount includes the posted balance adjusted by pending incoming and outgoing transactions, regardless of whether those funds are currently available for use.

Example:

If the posted balance is $1,000, a $500 payout is pending, and a $600 top-up is pending, the pending_amount is $1,100.

posted_amountinteger

The total balance derived only from finalized, settled transactions.

This amount represents the authoritative ledger balance and does not include any pending incoming or outgoing transactions.

Example:

If $1,000 has fully settled and no transactions have posted since, the posted_amount is $1,000, even if payouts or top-ups are currently in progress.

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)
type'DISBURSEMENT'

The type of transactions stored/ledgered on the Balance.

Changes

No recorded changes to this operation across all 27 revisions of this API.