POST/api/v2/banking/users/{userId}/budgets

POST /api/v2/banking/users/{userId}/budgets

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
userId (path)	integer (int32)	Yes

Request body

application/json

Request body fields
Field	Type	Required	Description
Name	string	Yes	Budget display name.
Currencies	array of string	Yes	ISO 4217 currency codes enabled for the budget, for example EUR or GBP.
Type	string	No	Optional requested budget type. Equals Money personal accounts are created as individual budgets and business accounts as shared budgets.
Features	array of string	No	Optional budget features. Supported value: peopleCards.
AllowCurrencyAlignment	boolean	No

Responses

201 — Created

Response 201 fields
Field	Type	Required
BudgetId	string	No
AccountId	string	No
Name	string	No
Type	string	No
ParentId	string	No
Status	string	No
AllowCurrencyAlignment	boolean	No
Currencies	array of string	No
Balances	array of UserBudgetBalance	No
CreatedAt	string (date-time)	No
UpdatedAt	string (date-time)	No

400 — Bad Request

Response 400 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

401 — Unauthorized

Response 401 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

404 — Not Found

Response 404 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

500 — Internal Server Error

Response 500 fields
Field	Type	Required
Message	string	No
Code	string	No
Status	unknown	No
ValidationErrors	object	No
Details	string	No

Example request

curl -X POST "https://{base_url}/api/v2/banking/users/{userId}/budgets" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Name":"…","Currencies":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.