Skip to main content

Currency


Use Currency to update the currency used for displayed prices.

Supported currencies and selection state derive from the change-currency response.



This screen includes:

#ElementDescription
1Search fieldFilters supported currencies
2Currency listDisplays available currencies
3Currency rowDisplays currency name and code
4Selected stateMarks the active currency
5Save actionApplies the selected currency
6Cancel actionCloses the modal without changes
7Close actionDismisses the modal

Workflow

  1. Open Account.
  2. Open Currency.
  3. Render available currencies.
  4. Filter currencies by search value.
  5. Select a currency.
  6. Save the selection.
  7. Refresh displayed prices.

Validations

ScenarioApp BehaviorSDK Output
Currency list emptyDisplay empty statecurrencies = empty
Search returns no resultsDisplay empty stateresults = empty
Session invalidBlock accessstate = unauthenticated
Currency unsupportedBlock selectionerror = unsupported_currency
Currency unchangedDisable Save actionstate = unchanged
Request rejectedDisplay error statestatus = 405

Actions

ScenarioApp BehaviorSDK Output
Currency screen openedLoad currenciesPUT /api/v3/account/change-currency
Search updatedFilter currency listPATCH /api/v3/account/change-currency/filter
Currency selectedUpdate pending selectioncurrency = selected
Save selectedApply selected currencyPOST /api/v3/account/change-currency
Cancel selectedDismiss without changesstate = unchanged
Screen closedPreserve active currencystate = unchanged

Endpoint Resources

Currency

PUT 

v3/account/change-currency

Displays the currency screen for changing displayed prices' currency.

Filter Currency

PATCH 

v3/account/change-currency/filter

Filters the currency list by currency name.

Change Currency

POST 

v3/account/change-currency

Updates the currency used for displayed prices.