FX conversionsConversions

The Conversion object (FX)

Description

The Conversion object allows you to convert funds in the Mangopay environment from one currency to another. The transaction takes place between two wallets of different currencies with the same owner. The two wallets can be either two Wallets created by the platform for its users, or two Client Wallets.

There are two types of conversion:

  • Instant (Spot FX) – Conversion executed without a quote, at the rate returned in the call.
  • Quoted (Guaranteed FX) – Conversion executed against an active Quote that previously locked in the rate.

Caution – Conversions can’t be refunded

A refund is not possible for a quoted or instant conversion. You must reconvert the funds by creating another conversion with the reverse currency pair.

Note – Activation required for feature and currencies

In Production, foreign exchange services are subject to a contract amendment.

In Sandbox, both the feature and currencies require activation for your API environment.

For more information or to activate contact the Support team via the Dashboard.

Attributes

IdstringOptional
QuoteIdstring or nullOptional
TypestringOptional
NaturestringOptional
CreationDateintegerOptional
StatusstringOptional
AuthorIdstringOptional
The unique identifier of the user at the source of the transaction. In a conversion, both the debited and credited wallets are owned by the author.
DebitedWalletIdstringOptional
CreditedWalletIdstringOptional
DebitedFundsobjectOptional
Information about the debited funds.
CreditedFundsobjectOptional
Information about the credited funds.
FeesobjectOptional
RequestedFeesobjectOptional
ResultCodestringOptional
ResultMessagestringOptional
The explanation of the result code.
ExecutionDateintegerOptional
ConversionRateResponseobjectOptional
MarginsResponseobjectOptional
Information about the margins calculated for the transaction.
TagstringOptional
Guide
Learn more about FX