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 Hub.
Attributes
The unique identifier of the object.
The unique identifier of the active quote which guaranteed the rate for the conversion.
The type of transaction.
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT
The nature of the transaction, providing more information about the context in which the transaction occurred:
REGULAR– Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.REPUDIATION– Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).REFUND– Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).SETTLEMENT– Transfer made to the repudiation wallet by the platform to settle a lost dispute.
The date and time at which the object was created.
Returned values: CREATED, SUCCEEDED, FAILED
The status of the transaction.
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.
The unique identifier of the debited wallet (in the sell currency).
The unique identifier of the credited wallet (in the buy currency).
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.
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.
Information about the conversion rate used during the transaction.
Max. length: 255 characters
Custom data that you can add to this object.
Related resources
Guide
Was this page helpful?