> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt
> Use this file to discover all available pages before exploring further.

# The Quote object (Guaranteed FX)

### Description

The Quote object represents an agreement to freeze a conversion rate, for a given currency pair, for a duration of time. 

Before it expires, an active quote can be used to create a quoted conversion at the quoted rate:

* Between user wallets, using <a href="/api-reference/conversions/create-quoted-conversion-user-wallets">POST Create a Quoted Conversion between user Wallets</a>
* Between client wallets, using <a href="/api-reference/conversions/create-quoted-conversion-client-wallets">POST Create a Quoted Conversion between Client Wallets</a>

A quote is not required to create an instant conversion.

### Attributes

<ParamField body="Id" type="string">
  The unique identifier of the object.
</ParamField>

<ParamField body="CreationDate" type="Unix timestamp">
  The date and time at which the object was created.
</ParamField>

<ParamField body="ExpirationDate" type="Unix timestamp">
  The date and time at which the quote expires and can no longer be used.
</ParamField>

<ParamField body="Status" type="string">
  **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.
</ParamField>

<ParamField body="DebitedFunds" type="object">
  Information about the debited funds.

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **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 currency of the debited funds (the sell currency).
    </ParamField>

    <ParamField body="Amount" type="integer">
      An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).

      During a conversion, (`DebitedFunds.Amount` - `Fees`) \* `MarketRate` = `CreditedFunds.Amount`. 
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="CreditedFunds" type="object">
  Information about the credited funds.

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **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 currency of the credited funds (the buy currency).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="Fees" type="object">
  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.

  <Expandable title="properties">
    <ParamField body="Currency" type="string">
      **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 currency of the fees.
    </ParamField>

    <ParamField body="Amount" type="integer">
      An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as `1260` whereas JPY 12 would be represented as just `12`).
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="ConversionRateResponse" type="object">
  Information about the conversion rate used during the transaction.

  <Expandable title="properties">
    <ParamField body="ClientRate" type="float">
      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`.
    </ParamField>

    <ParamField body="MarketRate" type="float">
      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.
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="Tag" type="string">
  Max. length: 255 characters

  Custom data that you can add to this object.\
  For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
</ParamField>

<ParamField body="Duration" type="integer">
  **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.
</ParamField>

### Related resources

<Card title="Guide" href="/guides/fx">Learn more about FX</Card>
