Quotes

This call guarantees a conversion rate for a quoted conversion.

If the quote is for a client wallet conversion then the quote:

  • Can't include Fees – the conversion attempt will return a 400 error if its QuoteId includes fees
  • Shouldn't include UserMargin – the conversion attempt will not be blocked but UserMargin is disregarded – in the ConversionRateResponse (the user's FinalRate is the same as the platform's ClientRate)
post/v2.01/{ClientId}/conversions/quote

Request

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

Path parameters

ClientIdstring required

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

Request body

OR

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

ExpirationDateinteger

Unix timestamp (UTC) of the date and time the quote expires and can no longer be used.

Statusstring

Returned values: ACTIVE, EXPIRED

The status of the quote:

  • ACTIVE – The quote can be used to execute a quoted conversion.
  • EXPIRED – The quote can't be used because the ExpirationDate is passed.
Tagstring

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

Durationinteger

Allowed values: 300, 3600

The time in seconds during which the quote is active and can be used for conversions.

By default, quotes are available for a duration of 5 or 60 minutes, as agreed between Mangopay and the platform.

Changes