conversionRates

View an indicative Conversion Rate

Changed on
<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}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/conversions/rate/{DebitedCurrency}/{CreditedCurrency}
  • Auth
    HTTP bearer

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).

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.

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id view_conversion_rate removed and replaced with conversionRates_view_conversion_rate