Skip to main content
inputCreateCurrencyCommandRequestInput

Fields

code
String!
required

The currency code. A standard currency uses its ISO 4217 alpha-3 code in capitals ('EUR'); a currency defined by the tenant uses a code with the prefix 'x-' in lower case ('x-loyalty'). Requests are matched ignoring case, responses always carry the canonical spelling.

name
String!
required

The display name, 1 to 20 characters.

symbol
String!
required

The currency symbol as plain text, 1 to 255 characters.

exchangeRate
Decimal!
required

Units of this currency per unit of the default currency, at least 0.001.

decimalSeparator
String!
required

The character between the whole part and the decimals, exactly one character.

thousandsSeparator
String

The character between groups of thousands, at most one character. Omitted means none.

Where the symbol stands relative to the amount. Omitted means after the amount.

idempotencyKey
String

Client-supplied idempotency key. When provided, a repeated request with the same key and payload replays the original result instead of re-executing the mutation.