Change

This endpoint is used to change the currency of a merchant's store and to represent prices for the products. Although the store payouts can be in a different currency, the customer can choose any of the currencies mentioned in the currency selection to display the prices.

TIP

The change endpoint has been implemented in the Localization Web Component, and It's all setup to save developer's time and effort.

Payload

ChangePayload

currency_code

string

optional

The store's currency code

Example:

SAR - USD

Response

Success

Error

currency.change.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

object

data

optional

Response data.

code

string

code

optional

Code of the Currency

Default:

SAR

symbol

string

symbol

optional

Symbol of the Currency

Example:

ر.س

Usage

To perform the action of changing the store's currency, the developer may call the change() method as below.

Events

This endpoint may trigger two events, the onChanged and onFailed events.

onChanged

This event is triggered when changing the store's currency is done without having any errors coming back from the backend.

onFailed

This event is triggered when changing the store's currency is not completed and an error has occurred.

Payload#

Response#

Usage#

Events#

onChanged#

onFailed#

Payload

Response

Usage

Events

onChanged

onFailed