Skip to main content

AccountBalances

Account balance for a single currency. One record per (accountId, currency) pair. All amounts are in the currency's minor units (e.g. cents for EUR).

type AccountBalances {
accountId: ID!
currency: String!
clearedAmount: Int!
outstandingAmount: Int!
totalAmount: Int!
createdAt: String!
updatedAt: String
}

Fields

AccountBalances.accountId ● ID! non-null scalar

Owning account this balance belongs to.

AccountBalances.currency ● String! non-null scalar

ISO 4217 currency code of this balance (e.g. EUR).

AccountBalances.clearedAmount ● Int! non-null scalar

Settled funds available for refunds or outbound payments. Minor units.

AccountBalances.outstandingAmount ● Int! non-null scalar

Pending funds from transactions not yet settled. Minor units.

AccountBalances.totalAmount ● Int! non-null scalar

Sum of cleared and outstanding amounts. Minor units.

AccountBalances.createdAt ● String! non-null scalar

Creation timestamp (ISO 8601).

AccountBalances.updatedAt ● String scalar

Last update timestamp (ISO 8601).

Member Of

AccountBalancesConnection object