Skip to navigation
FX conversionsQuotes

View a Quote

View a Quote

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

Response

Success
IdstringOptional

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

The unique identifier of the object.

CreationDateintegerOptional

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

ExpirationDateintegerOptional

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

StatusstringOptional

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.
DebitedFundsobjectOptional
Information about the debited funds.
CreditedFundsobjectOptional
Information about the credited funds.
FeesobjectOptional

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Note: The fees currency must match the debited funds currency.

ConversionRateResponseobjectOptional

Information about the MarketRate used to convert funds and other indicative rates.

RequestedFeesobjectOptional

Information about the Fees sent in the request.

MarginsResponseobjectOptional
Information about the margins calculated for the transaction.
TagstringOptional

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}".

DurationintegerOptional

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.