Skip to main content
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.
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.
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
  }'

Path parameters

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

Query parameters

accountId
string
required
The ID of the account to work with.Allowable values: An existing accountId (≤ 36 characters)

Request body schema

enabled
boolean
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.
{
  "id": "af849178-b239-4661-9140-8ebe467d3541",
  "code": "GBP",
  "name": "Pound Sterling",
  "status": {
    "enabled": true
  }
}
For more detailed information about this request and its response, see the API reference.