Skip to navigation

View an indicative Conversion Rate

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.

View an indicative Conversion Rate

Learn more about FX →

Authentication

AuthorizationBearer

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.

Path parameters

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

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

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

CreditedCurrencystringRequired

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

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

Response

Success
DebitedCurrencystringOptional

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

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

CreditedCurrencystringOptional

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

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

ClientRatedoubleOptional

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.

MarketRatedoubleOptional

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.

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

Errors

400
Bad Request Error