convertCurrency( )

Returns an array of amounts converted from the original (from) currency to the target (to) currency and the timestamp for the conversion rate used.

Use the convertCurrency() function to convert an array of one or more amounts between two currencies. The convertCurrency() function returns an array of converted amounts and the timestamp for the conversion rate used.

Note: The currency codes used must exist in the array of supported currencies returned by the listCurrencies() function.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user’s permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Currencies
Manage Stores - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
identifiersConvertCurrencyIdentifiersRequired

Identifying details needed to determine which currency rate to convert. The combination of the from and to properties together comprise the unique ID.

amountsArray<DecimalValue>Required

Amounts to convert.

Returns
Return Type:Promise<ConvertCurrencyResponse>
JavaScript
Errors

This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?