Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
- Bank wires
- Virtual IBAN
- Direct debits
- Web direct debits
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
- Swish
- TWINT
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
View a Conversion
All conversions returned by this endpoint contain the QuoteId parameter. For instant conversions, it is null.
Note – Conversion data retained for 13 months
An API call to retrieve a conversion whose CreationDate is older than 13 months may return 404 Not Found.
For more information, see the Data availability periods article.
Path parameters
The unique identifier of the conversion.
Responses
The unique identifier of the object.
The unique identifier of the active quote which guaranteed the rate for the conversion.
Returned null in the case of an instant 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.
Returned 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.
Returned 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).
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, CreditedFunds.Amount = (DebitedFunds.Amount - Fees) * MarketRate.
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.
Returned 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).
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. 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.
The unique identifier of the object.
The unique identifier of the active quote which guaranteed the rate for the conversion.
Returned null in the case of an instant 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.
Returned 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.
Returned 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).
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, CreditedFunds.Amount = (DebitedFunds.Amount - Fees) * MarketRate.
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.
Returned 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).
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. 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.
Was this page helpful?