Skip to main content
GET
/
api
/
v1
/
account-balances
Retrieve Account Balance
const url = 'https://api.gnosispay.com/api/v1/account-balances';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}, body: undefined};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
{
  "total": "<string>",
  "spendable": "<string>",
  "pending": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

The account balance details.

​
total
string<^[0-9]+$>
required

The total balance for this account (spendable and pending).

​
spendable
string<^[0-9]+$>
required

The amount that can be spent from this account.

​
pending
string<^[0-9]+$>
required

The amount that is being reviewed for spending.