Skip to main content
POST
/
v2.01
/
{ClientId}
/
clients
/
conversions
/
quoted-conversion
{
  "QuoteId" : "cvrquote_01J475ZRENK67V9A62JCQ6PYVW",
  "DebitedWalletType" : "FEES",
  "CreditedWalletType" : "CREDIT",  
  "Tag": "Created using Mangopay API Collection Postman"
}

{
    "Id": "cvr_01J475ZYZ6WBZK3JK3HSZFXHVN",
    "QuoteId": "cvrquote_01J475ZRENK67V9A62JCQ6PYVW",
    "Type": "CONVERSION",
    "Nature": "REGULAR",
    "CreationDate": 1722523057,
    "Status": "SUCCEEDED",
    "AuthorId": "your-client-id",
    "DebitedWalletId": "FEES_EUR",
    "CreditedWalletId": "CREDIT_GBP",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 10
    },
    "CreditedFunds": {
        "Currency": "GBP",
        "Amount": 8
    },
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1722523057,
    "ConversionRateResponse": {
        "ClientRate": 0.8352637,
        "MarketRate": 0.84336
    },
    "Tag": "Created using Mangopay API Collection Postman"
}
This call triggers a conversion at the rate defined in its quote. The debited funds (buy currency), credited funds (sell currency) and currencies are defined in the quote. The Client Wallets to debit and credit are defined in the conversion. Each quoted conversion requires a dedicated Quote object, linked in the QuoteId. Quoted conversions between client wallets:
  • Can’t include Fees – the conversion attempt will return a 400 error if its QuoteId includes fees
  • Shouldn’t include UserMargin – the conversion attempt will not be blocked, but UserMargin is disregarded – in the ConversionRateResponse (the user’s FinalRate is the same as the platform’s ClientRate)

​
Body parameters

​
QuoteId
string
required
The unique identifier of the active quote which guaranteed the rate for the conversion.
​
DebitedWalletType
string
required
Allowed values: FEES, CREDITThe type of the client wallet to be debited:
  • FEES – Fees Wallet, for fees collected by the platform.
  • CREDIT – Repudiation Wallet, for funds related to dispute management.
The amount and currency of the debited funds are defined by the quote.
​
CreditedWalletType
string
required
Allowed values: FEES, CREDITThe type of the client wallet to be credited:
  • FEES – Fees Wallet, for fees collected by the platform.
  • CREDIT – Repudiation Wallet, for funds related to dispute management.
The amount and currency of the credited funds are defined by the quote.
​
Tag
string
Max. length: 255 charactersCustom 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.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
QuoteId
string
The unique identifier of the active quote which guaranteed the rate for the conversion.Returned null in the case of an instant conversion.
​
Type
string
The type of transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
​
AuthorId
string
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.
​
DebitedWalletId
string
The unique identifier of the debited wallet (in the sell currency).
​
CreditedWalletId
string
The unique identifier of the credited wallet (in the buy currency).
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds.
​
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
​
ResultMessage
string
The explanation of the result code.
​
ExecutionDate
Unix timestamp
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.
​
ConversionRateResponse
object
Information about the MarketRate used to convert funds and other indicative rates.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
Functional errors (ResultCode) are possible on a 200 response. Read more → 
{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "b4372752-a7dd-4751-b894-d2c960df3e5c",
    "Date": 1721729683.0,
    "errors": {
        "QuoteId": "No fees allowed on client quoted conversion"
    }
}

{
    "Id": "cvr_01J475ZYZ6WBZK3JK3HSZFXHVN",
    "QuoteId": "cvrquote_01J475ZRENK67V9A62JCQ6PYVW",
    "Type": "CONVERSION",
    "Nature": "REGULAR",
    "CreationDate": 1722523057,
    "Status": "SUCCEEDED",
    "AuthorId": "your-client-id",
    "DebitedWalletId": "FEES_EUR",
    "CreditedWalletId": "CREDIT_GBP",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 10
    },
    "CreditedFunds": {
        "Currency": "GBP",
        "Amount": 8
    },
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1722523057,
    "ConversionRateResponse": {
        "ClientRate": 0.8352637,
        "MarketRate": 0.84336
    },
    "Tag": "Created using Mangopay API Collection Postman"
}

{
  "QuoteId" : "cvrquote_01J475ZRENK67V9A62JCQ6PYVW",
  "DebitedWalletType" : "FEES",
  "CreditedWalletType" : "CREDIT",  
  "Tag": "Created using Mangopay API Collection Postman"
}