Sign in

v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
conversionRates

View an indicative Conversion Rate

<Note icon="fa-regular fa-circle-info"> **Note – Rate is not guaranteed**

The rate returned by the API is indicative of the rate offered by Mangopay, but it is not a guaranteed rate. For quoted conversions, the rate is guaranteed by the quote. For instant conversions, the rate is displayed in the response. </Note>

View an indicative Conversion Rate

Learn more about FX →

get/v2.01/{ClientId}/conversions/rate/{DebitedCurrency}/{CreditedCurrency}

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

DebitedCurrencystring required

Allowed values: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

The sell currency (the currency of the debited wallet during a conversion).

CreditedCurrencystring required

Allowed values: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

The buy currency (the currency of the credited wallet during a conversion).

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Response

Success

DebitedCurrencystring

Returned values: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

The sell currency (the currency of the debited wallet during a conversion).

CreditedCurrencystring

Returned values: The three-letter <a href="/api-reference/overview/data-formats" target="_blank">ISO 4217 code</a> (EUR, GBP, etc.) of a <a href="/guides/currencies" target="_blank">supported currency</a> (depends on feature, contract, and activation settings).

The buy currency (the currency of the credited wallet during a conversion).

ClientRatenumber double

Max. 7 decimal places

The rate including Mangopay’s markup, indicative of the rate invoiced during the billing cycle: ClientRate = MarketRate * (1 - markup).

The ClientRate fluctuates in line with the MarketRate.

MarketRatenumber double

Max. 7 decimal places

The rate used to convert funds during a conversion: (DebitedFunds.Amount - Fees) * MarketRate = CreditedFunds.Amount.

The market rate fluctuates in line with FX market dynamics and is common to all platforms for the currency pair.

MarketRateDateinteger

The date and time at which the market rate was retrieved.