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

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

Authentication

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

Parameters

Request parameters
Field	Type	Required
budgetId (path)	string	Yes
accountId (query)	string	No
userId (query)	unknown	No

Request body

application/json

Request body fields
Field	Type	Required	Description
destinationBudgetId	string	No	Destination budget ID for the transfer
currency	string	No	Currency code for the transfer (e.g., USD, GBP, EUR)
amount	string	No	Amount to transfer
reference	string	No	Reference for the transfer

Responses

200 — OK

Response 200 fields
Field	Type	Required	Description
success	boolean	No	Indicates if the transfer was successful
debitBoxTransactionId	unknown	No	Transaction ID for the debit operation
creditBoxTransactionId	unknown	No	Transaction ID for the credit operation

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/budgets/{budgetId}/transfer" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

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