/ Guides / Budgets / Make budget transfers

Make budget transfers

Transfer funds from one budget to another within an account.

Make a budget transfer

Post/v2/budgets/{budgetId}/transfer

Before you start

If you haven't already, create a new budget and grab the newly-created budget's id.

Request

Use this request to transfer funds from one budget to another, within an account.

Sample requestRequest structure
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/budgets/b489ea2c-0dd1-4fb1-b345-de5a596a5527/transfer?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "destinationBudgetId": "4bf13dc8-d128-4521-99b8-4002b8987499",
    "currency": "USD",
    "amount": "300"
  }'
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/budgets/{budgetId}/transfer?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "destinationBudgetId": "string",
    "currency": "string",
    "amount": "string"
  }'

Path parameters

Parameter Description
budgetId
string
required		 The ID of the budget from which you're transferring funds.

Allowable values:
An existing budgetId (<= 36 characters)

Query parameters

Parameter Description
accountId
string
required		 The ID of the account that this budget belongs to.

Allowable values:
An existing accountId

Request body schema

Parameter Description
destinationBudgetId
string
required		 The ID of the budget to which you're transferring funds.

Allowable values:
An existing budgetId (<= 36 characters)
currency
string
required		 The currency code for the currency that the transfer is in, in ISO 4217 format.

Allowable values:
3 characters (^[A-Z]{3}$)
amount
string
required		 The amount of funds that you're transferring.

Allowable values:
A valid string

Response

If your request is successful, you'll receive a 200 response.

Sample responseResponse structure
Copy
Copied
{
  "success": true,
  "debitBoxTransactionId": 179032,
  "creditBoxTransactionId": 179033
}
Copy
Copied
{
  "success": boolean,
  "debitBoxTransactionId": number,
  "creditBoxTransactionId": number
}

For more detailed information about this request and its response, see the API reference.