BTbtcpayserver
Groups

Get balance of a group

Changed on
get/v1/cryptos/{cryptoCode}/groups/{groupId}/balance

Request

Path parameters

cryptoCodestring required

The cryptocurrency code to track (e.g., 'BTC' for Bitcoin, 'LTC' for Litecoin).

groupIdstring required

The unique identifier for the group.

Response

Balance information

unconfirmedinteger

Represents how the confirmed balance would be updated once all unconfirmed transactions are confirmed.

confirmedinteger

The balance of all funds in confirmed transactions.

availableinteger

The total spendable balance, calculated as total minus immature funds.

immatureinteger

The total unspendable funds (e.g., coinbase rewards that need 100 confirmations before being spendable).

totalinteger

The total funds owned, calculated as confirmed plus unconfirmed balances.

Changes