Get entity balance

Retrieves balance and details of an entity using their nanoid (te- for team, co- for company, us- for user).

GET /v2/balance

Get entity balance

cURL

curl --request GET \
  --url https://b2b-api.dev-riseworks.io/v2/balance \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "rise_account_address": "<string>",
    "balances": [
      {
        "balance_cents": "<string>"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

nanoid · string · required

Nanoid of the entity to retrieve.

Pattern: ^(te-|co-|us-)

currencies · enum<string>[] · required

Optional array of currencies to retrieve balances for. If not provided, returns all supported currencies.

Available options: BTC, CAD, EUR, GBP, USD, USDC, USDT

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes