Fields

Currency Field

The currency field allows capturing a monetary value, in a specific currency.

The supported currency codes are based on the ISO 4217 standard.

Basic usage

Adds a currency field to the fields of an action.

Result

Parameters

See fields for common parameters.

params.currency

The specific currency to be used.
For example, can be set to 'USD' or 'EUR' or any ISO 4217 currency code.

If unset, the user will be able to select the currency from a list of all available currencies after considering the whitelist and blacklist.

params.currency_whitelist

Limits the available currencies to the ones in the list.
For example, can be set to ['USD', 'EUR'] to only allow US Dollars and Euros.

params.currency_blacklist

Excludes the currencies in the list from the available currencies.
For example, can be set to ['AUD', 'GBP'] to exclude Australian Dollars and British Pounds.