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

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

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
budgetId (path)	string	Yes

Request body

application/json

Request body fields
Field	Type	Required
DestinationBudgetId	string	Yes
Amount	unknown	Yes
Currency	string	Yes
Reference	string	No

Responses

200 — OK

Response 200 fields
Field	Type	Required
Success	boolean	No
TransferId	string	No
SourceBudgetId	string	No
DestinationBudgetId	string	No
Currency	string	No
Amount	string	No
Reference	string	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/{budgetId}/transfer" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"DestinationBudgetId":"…","Amount":"…","Currency":"…"}'

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