Step 3: create a budget

To create a budget, you'll need the ID of your account's parent budget (accountBalance). You'll also need to choose a name, which features to enable, which currencies to enable, and which type the budget should be.

features can be set to one or several of payments, peopleCards, and budgetCards. Choose payments if you're using your account for payments. Choose peopleCards and/or budgetCards if you're using it for cards, depending on whether you want cards to be associated with people (individual or shared budgets), budgets (shared budgets only), or both.

type can be set to shared or individual. Choose shared if you want multiple people to be able to access the budget. For example, ACME's Marketing team. Choose individual if you want only one person to access the budget. For example, Barbara Babel, ACME's Head of Localisation.

In this example, the account we're using has payments enabled, so we're adding payments to the budget too.

SandboxProduction

Copy

Copied

curl --location 'https://api-sandbox.equalsmoney.com/v2/budgets?accountId={accountId}' \ # Your account ID
-H 'Authorization: ApiKey {apiKey}' \ Your API key
-H 'Content-Type: application/json' \
-d '{
  "parentId": "{parentId}", # The ID of your parent budget
  "name": "Test budget",
  "features": [
    "payments"
  ],
  "currencies": [
    "GBP",
    "USD"
  ],
  "type": "shared"
}'

Copy

Copied

curl --location 'https://api.equalsmoney.com/v2/budgets?accountId={accountId}' \ # Your account ID
-H 'Authorization: ApiKey {apiKey}' \ Your API key
-H 'Content-Type: application/json' \
-d '{
  "parentId": "{parentId}", # The ID of your parent budget
  "name": "Test budget",
  "features": [
    "payments"
  ],
  "currencies": [
    "GBP",
    "USD"
  ],
  "type": "shared"
}'

If your request is successful, you'll receive a 201 response containing details about the budget, including its id.

info

In sandbox, the response includes a list of all currencies supported by the bank. This doesn't mean they are currently enabled for this budget, just that they can be.

Copy

Copied

{
  "createdAt": "2023-09-29T10:29:28.662Z",
  "updatedAt": "2023-09-29T10:29:28.662Z",
  "id": "4a535fb3-1302-45c7-8d4d-a42951ecc78e",
  "status": "active",
  "parentId": "6e08e7f7-f906-469e-b061-3dcb6def9b20",
  "name": "Test budget",
  "type": "shared",
  "accountId": "F12345",
  "feature": [
    {
      "createdAt": "2023-09-29T10:29:28.662Z",
      "updatedAt": "2023-09-29T10:29:28.707Z",
      "id": "7d2a641e-0070-4430-8ddb-4e2c39d13029",
      "payments": true,
      "budgetCards": false,
      "peopleCards": false,
      "forwardDeposits": false,
      "BudgetId": "4a535fb3-1302-45c7-8d4d-a42951ecc78e"
    }
  ],
  "allowCurrencyAlignment": false,
  "boxId": "d79d2433-ffc9-4154-ae0f-a07599e8c531",
  "details": [
    {
      "currency": "GBP",
      "sortCode": "23-18-84",
      "accountNumber": "21008072",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "accountName": "ACME",
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "EUR",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "USD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "AED",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "AUD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "BBD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "BGN",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "BHD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "CAD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "CHF",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "CZK",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "DKK",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "GHS",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "HKD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "HRK",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "HUF",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "ILS",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "JPY",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "KES",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "MWK",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "MXN",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "NOK",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "NZD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "OMR",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "PHP",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "PKR",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "PLN",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "QAR",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "RON",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "SAR",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "SEK",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "SGD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "THB",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "TND",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "TRY",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "TTD",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "UGX",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "ZAR",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    },
    {
      "currency": "ZMW",
      "sortCode": null,
      "accountNumber": null,
      "accountName": "ACME",
      "ibans": [
        {
          "iban": "GB93SPPV23188421008072",
          "bic": "SPPVGB2L"
        }
      ],
      "bankName": "SPECTRUM PAYMENT SERVICES",
      "bankAddress": "Vintners Place\n68 Upper Thames St\nLondon\nEC4V 3BJ\nUnited Kingdom",
      "balanceReference": null
    }
  ]
}