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": 150000,
    "currency": "EUR"
  },
  "GBP": {
    "amount": 250000,
    "currency": "GBP"
  },
  "USD": {
    "amount": 0,
    "currency": "USD"
  }
}

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.

Response

Savings balance response.

Map of savings products where the key is the savings product identifier (currency) and the value contains the amount and currency information.

{key}
object