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.
The date and time at which the quote expires and can no longer be used.
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 theExpirationDateis passed.
Information about the debited funds.
Information about the credited funds.
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.
Information about the conversion rate used during the transaction.
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.
Related resources
Guide
Was this page helpful?