# Create a currency

```http
POST https://secure.yoprint.com/v1/api/store/{team_slug}/setting/currency
```

- API version: v1
- Operation ID: `v1_public_currency_store`
- Section: Team settings › [Currencies](https://developer.yoprint.com/reference/currencies.md)
- Web page: https://developer.yoprint.com/reference/currencies/v1-currency-store/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Adds a currency and returns it. It becomes the default only when the team has no currency yet.

YoPrint works in one currency per team: the default currency. Its `symbol` appears on PDFs, emails and formatted amounts (such as `formatted_calc_total`), and its `iso` code is sent to integrations such as QuickBooks and Shopify. A new sales order records the default currency when it is created, and YoPrint doesn't convert between currencies.

The team's first currency is its default. No operation changes the default: `default` in a request is ignored.

## Permission

Needs the Manage Settings permission.

## Business rules

- `name`, `iso` (exactly 3 characters) and `symbol` are required.
- `rate`, when sent, is greater than 0.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

Content type `application/json`, required.

Fields:

- `iso` (string, required): The three-letter ISO 4217 code, such as `CAD`. YoPrint checks only that it is 3 characters long, and saves it in capitals. Exactly 3 characters.
- `name` (string, required)
- `symbol` (string, required)
- `auto_rate` (boolean, optional): Stored but not used or returned.
- `default` (boolean, optional): Ignored.
- `rate` (number, optional): Stored but not used or returned. Greater than 0.

### Example request

```bash
curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/setting/currency' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1' \
  -H 'Content-Type: application/json' \
  -d '{
    "iso": "CAD",
    "name": "Canadian Dollar",
    "symbol": "CA$"
  }'
```

## Response

`200` Successful response.

Fields:

- `data` (object, required)
  - `default` (boolean, required): Whether it is the team's currency.
  - `id` (string, required)
  - `iso` (string, required): The three-letter ISO 4217 code, in capitals.
  - `name` (string, required)
  - `symbol` (string, required)
  - `trashed` (boolean, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": {
    "default": false,
    "id": "f468IevwjuSudz",
    "iso": "CAD",
    "name": "Canadian Dollar",
    "symbol": "CA$",
    "trashed": false
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
  - When: The API key is missing or wrong. Fix: Send your personal API key as `Authorization: Bearer YOUR_API_KEY`.
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
  - When: Your permission group lacks Manage Settings. This 403 has a short body, `{"message": "Insufficient Permission"}`, without `success` or `error`. Fix: Ask the team owner to give your permission group Manage Settings.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.
- `422` The request was refused and changed nothing. `validation_failed` lists what to fix in `error.fields`; other codes name a business rule, explained in `error.message`. A few checks answer with only `{"message": "..."}`. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer `connect_timeout` ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.
  - When: A required field is missing, `iso` is not 3 characters, or `rate` is 0 or less. `error.code` is `validation_failed`, and `error.fields` names each field with its messages. Fix: Fix the fields listed in `error.fields` and send the request again.

## Notes

- Adding a currency changes nothing else: amounts keep using the default currency.

## Related

- [List currencies](https://developer.yoprint.com/reference/currencies/v1-currency-index.md): `GET /v1/api/store/{team_slug}/setting/currency`