List

This endpoint is used to list the currencies of a merchant's store. Although the store payouts can be in a different currency, the store's owners can list the different available currencies in the store.

TIP

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

Response

Success

Error

currency.list.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

data

array[object (Currency) {5}]

optional

code

string

required

Code of the Currency

Example:

SAR

name

string

required

Name of the currency

Example:

ريال سعودي

symbol

string

required

Symbol of the currency

Example:

ر.س

amount

string

required

Currency amount

Example:

200

country_code

string

required

Currency country code

Example:

Usage

To perform the action of listing the avaliabe currencies for the store, the developer can call list() method.

Events

This endpoint may trigger two events, the onFetched and onFailedToFetch events.

onFetched

This event is triggered when listing the avaliabe currencies for the store is done without having any errors coming back from the backend.

onFailedToFetch

This event is triggered when listing the avaliabe currencies for the store is not completed and an error has occurred.

Response#

Usage#

Events#

onFetched#

onFailedToFetch#

Response

Usage

Events

onFetched

onFailedToFetch