Skip to main content

Balance

Overview​

On the BlockWyre platform, the balance represents the amount of available and pending funds in different currencies for an account. The balance is a crucial metric that allows account holders to understand their financial situation in real-time.

The BlockWyre balance is broken down for each coin that the account holds. This means that each type of currency, whether cryptocurrency or fiat currency, has its own associated balance within the account. In v3, fiat balances are also broken down per bank account, with a total per coin.

Balance Types​

v3 fieldv2 fieldIs
availableavailableWhat can be spent now.
pending_creditsincomingPendingIncoming funds not available yet.
pending_debitsoutgoingPendingFunds held for an outgoing operation still in flight.
reservedreservedFunds set aside in the account's reserve. They belong to the account but cannot be spent, and are not part of available.

In v3 each amount is a money object, { "amount": "1250.75", "currency": "USD" }. See List Balances.

Available​

The Available balance is the amount of funds that are available for immediate use. This is the balance that the account holder can use to make transactions, payments, or currency conversions without restrictions.

Pending credits (IncomingPending)​

Funds that are in the process of being received but are not yet available for use, for example a deposit awaiting blockchain network confirmation or bank settlement, or the proceeds of a trade being settled. v3 calls it pending_credits; v2 calls it incomingPending.

Pending debits (OutgoingPending)​

Funds held for an operation that is sending them out of the account, such as a withdrawal or a trade, until the network or the receiving entity confirms it. They are no longer available. v3 calls it pending_debits; v2 calls it outgoingPending.

Reserved​

Funds set aside in the account's reserve account, for example from completed ACH pulls. They are the account's money but can never be spent, and they are not counted in available. Zero everywhere except on the reserve account.

Key Terminology​

  • Balance: The amount of available and pending funds in different currencies.
  • Coin: Each type of currency, whether cryptocurrency or fiat currency, that the account holds.
  • Available: Funds available for immediate use.
  • Pending credits (v2 incomingPending): Funds in the process of being received but not yet available.
  • Pending debits (v2 outgoingPending): Funds held for an outgoing operation not yet confirmed.
  • Reserved: Funds set aside in the reserve account; never spendable.

Conclusion​

The balance on the BlockWyre platform provides a detailed and accurate view of the account's funds, broken down by each type of currency. By understanding the different types of balances (available, pending credits, pending debits and reserved), account holders can better manage their assets and make informed financial decisions.

Support and Resources​

If you need assistance or have any questions, our support team is here to help. You can contact our support team at support@blockwyre.com.

Stay Updated​

Stay up-to-date with the latest news, updates, and features from BlockWyre by following us on social media:

We are excited to have you on board and look forward to seeing how you leverage BlockWyre's powerful tools to enhance your financial operations. Happy integrating!