convertCurrency( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

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.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Currencies
Learn more about permission scopes.
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>
Was this helpful?
Yes
No