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

Try it

Get entity balance

cURL

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

200

{
  "success": true,
  "data": {
    "rise_account_address": "<string>",
    "balances": [
      {
        "currency": "USD",
        "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.

currencies · enum<string>[]

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

Available options: USD, EUR

Response

200

application/json

Default Response

success · enum<boolean> · required

Available options: true, false

data · object · required

Show child attributes

data. rise_account_address · string · required

Rise account address.

data. balances · object[] · required

Array of balances for different currencies.

Show child attributes

data.balances. currency · enum<string> · required

Currency code.

Available options: USD, EUR

data.balances. balance_cents · string · required

Balance in cents (as string).