Skip to main content
GET
/
savings-vault
Get user savings vault balance
curl --request GET \
  --url https://{host}/savings-vault \
  --header 'Authorization: Bearer <token>' \
  --header 'x-user-id: <x-user-id>'
{
  "EUR": {
    "amount": 1500.00,
    "currency": "EUR",
    "unrealisedInterest": 12.45
  }
}

​
Response Structure

The savings vault returns a map with the currency code as the key (currently only EUR is supported): 
{
  "EUR": {
    "amount": 1500.00,
    "currency": "EUR",
    "unrealisedInterest": 12.45
  }
}

​
Response Fields

  • amount: The current savings balance in whole currency units (EUR)
  • currency: The currency code (always EUR for this endpoint)
  • unrealisedInterest: Interest earned but not yet paid out, in whole currency units
Unrealised interest represents interest that has been accrued but not yet distributed to the user’s account. This typically includes interest earned in the current month that will be paid out at the beginning of the next month.

​
Use Cases

This endpoint is ideal for:
  • Displaying the user’s total savings balance in your application
  • Showing pending interest earnings before the next payout
  • Building savings overview dashboards
  • Calculating total assets under management
Combine the amount and unrealisedInterest fields to show users their total savings value including pending earnings.

Authorizations

​
Authorization
string
header
required

Auth0-issued access token that includes the scopes listed for the endpoint.

Headers

​
x-user-id
string
required

User identifier for the M2M client to specify which user's data to access.

Pattern: ^[a-f0-9]{24}$

Response

Savings balance response.

Map containing EUR savings balance. The key is the currency code (EUR) and the value contains the amount, currency, and unrealised interest. Only EUR savings are returned.

​
{key}
object