Manage account currencies

Decide which currencies to enable or turn off on your account. When you enable a currency, we'll automatically create a new budget in that currency. Similarly, when you create a budget in a currency, we'll then update the status of that currency on your account.

info

You can only enable a currency that you can already hold. See About account currencies for more information. If you're still unsure, contact your account manager.

Update a currency

Patch/v2/currencies/{currencyCode}

Request

Use this request to update the status of a currency on your account.

Sample requestRequest structure

Copy

Copied

curl -i -X PATCH \
  'https://api.equalsmoney.com/v2/currencies/GBP?accountId=F12345' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": true
  }'

Copy

Copied

curl -i -X PATCH \
  'https://api.equalsmoney.com/v2/currencies/{currencyCode}?accountId={accountId}' \
  -H 'Authorization: ApiKey YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "enabled": boolean
  }'

Path parameters

Parameter	Description
`currencyCode` string required	The currency code of the currency to work with, in ISO 4217 format. Allowable values: 3 characters

Query parameters

Parameter	Description
`accountId` string required	The ID of the account to work with. Allowable values: An existing `accountId` (<= 36 characters)

Request body schema

Parameter	Description
`enabled` integer	Whether or not the currency should be enabled. Set this to `true` to enable a currency. Allowable values: `true`, `false`

Response

If your request is successful, you'll receive a 200 response containing details about the currency, including its enabled status.

Sample responseResponse structure

Copy

Copied

{
  "id": "af849178-b239-4661-9140-8ebe467d3541",
  "code": "GBP",
  "name": "Pound Sterling",
  "status": {
    "enabled": true
  }
}

Copy

Copied

{
  "id": "string",
  "code": "string",
  "name": "string",
  "status": {
    "enabled": boolean
  }
}

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