Skip to main content
GET
/
cash
Get user cash balance
curl --request GET \
  --url https://{host}/cash \
  --header 'Authorization: Bearer <token>' \
  --header 'x-user-id: <x-user-id>'
{ "currency": "USD", "amount": 1234.56, "amountSettled": 1000, "asOf": "2025-10-03T10:00:00Z" }

Authorizations

​
Authorization
string
header
required

OAuth 2.0 bearer token issued by Wealthyhood. Include this token in the Authorization header as Bearer <token>.

Headers

​
x-user-id
string
required

The bank's unique identifier for the acting customer. Must match the user associated with the bearer token.

Example:

"bank-user-12345"

Query Parameters

​
currency
enum<string>

Optional ISO 4217 currency code to filter results (e.g., USD, EUR, GBP). If omitted, returns all currencies.

Available options:
GBP,
EUR,
USD
Example:

"USD"

Response

Cash balance response.

​
currency
enum<string>
required

ISO 4217 currency code.

Available options:
GBP,
EUR,
USD
Example:

"USD"

​
amount
number
required

Available cash amount as a number

Required range: x >= 0
Example:

1234.56

​
amountSettled
number
required

Settled cash amount as a number; funds that have cleared and count toward withdrawable balance

Example:

1000

​
asOf
string<date-time>
required

Timestamp when the balance was calculated.

Example:

"2025-10-03T10:00:00Z"