Create a budget-to-budget transfer

Transfer money from one budget to another budget.

SecurityCommonAuth
Request
path Parameters
budgetId
required
string <uuid> (budgetId) <= 36 characters

The ID of the budget to work with.

Example: b489ea2c-0dd1-4fb1-b345-de5a596a5527
query Parameters
accountId
required
string (accountId)

The ID of the account to work with.

Example: accountId=F50072
Request Body schema: application/json
required
destinationBudgetId
required
string <uuid> (budgetId) <= 36 characters

The ID of the budget.

currency
required
string (currencyCode) ^[A-Z]{3}$

The currency code, in ISO-4217 format.

amount
required
string

The amount to be transferred.

Responses
200

OK

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

422

Unprocessable content

429

Too many requests

500

Internal server error

post/budgets/{budgetId}/transfer
Request samples
application/json
{
  • "destinationBudgetId": "b489ea2c-0dd1-4fb1-b345-de5a596a5527",
  • "currency": "USD",
  • "amount": "string"
}
Response samples
application/json
{
  • "success": true,
  • "debitBoxTransactionId": 179032,
  • "creditBoxTransactionId": 179033
}