The Quote object (Guaranteed FX)
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 POST Create a Quoted Conversion between user Wallets
- Between client wallets, using POST Create a Quoted Conversion between Client Wallets
A quote is not required to create an instant conversion.
Attributes
The unique identifier of the object.
The date and time at which the object was created.
Format: “MMYY”
The expiration date of the card.
Allowed values: VALIDATION_ASKED
The status of the dispute document.
Information about the debited funds.
properties
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the debited funds (the sell currency).
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.
Information about the credited funds.
properties
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the credited funds (the buy currency).
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.
properties
Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).
The currency of the fees.
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).
Information about the conversion rate used during the transaction.
properties
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.
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.
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.
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.