Skip to main content
POST
/
v2.01
/
{ClientId}
/
conversions
/
quote
{
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "USD"
    },
    "Fees": {
        "Currency": "GBP",
        "Amount": 100
    },
    "Duration": 300,
    "Tag": "Created using the Mangopay API Postman collection"
}

{
    "Id": "cvrquote_01J3G082JEQRQ4WGJPSVF5GPS7",
    "CreationDate": 1721745279,
    "ExpirationDate": 1721745579,
    "Status": "ACTIVE",
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "USD",
        "Amount": 1163
    },
    "Fees": {
        "Currency": "GBP",
        "Amount": 100
    },
    "ConversionRateResponse": {
        "ClientRate": 1.2793195,
        "MarketRate": 1.29172
    },
    "Tag": "Created using the Mangopay API Postman collection"
}
This call guarantees a conversion rate to let you Create a Quoted Conversion.

​
Body parameters

​
DebitedFunds
object
required
Information about the debited funds.
​
CreditedFunds
object
required
Information about the credited funds.
​
Fees
object
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).Note: For conversions between client wallets, the quote cannot have Fees specified.
​
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.
​
Duration
integer
required
Allowed values: 300, 3600The 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.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
CreationDate
Unix timestamp
The date and time at which the object was created.
​
ExpirationDate
Unix timestamp
The date and time at which the quote expires and can no longer be used.
​
Status
string
Returned values: ACTIVE, EXPIREDThe status of the quote:
  • ACTIVE – The quote can be used to execute a quoted conversion.
  • EXPIRED – The quote can’t be used because the ExpirationDate is passed.
​
DebitedFunds
object
Information about the debited funds.
​
CreditedFunds
object
Information about the credited funds.
​
ConversionRateResponse
object
Information about the conversion rate used during the transaction.
​
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.
{
    "Message": "Duration 90 is not in the allowed list: 300, 3600",
    "Type": "forbidden_ressource",
    "Id": "3af49cbd-d68c-403c-8a37-b1ef40c224a6",
    "Date": 1707299786,
    "errors": null
}  

{
    "Message": "The currency JPY is not enabled for Forex. Contact your support to activate this feature.",
    "Type": "forbidden_ressource",
    "Id": "0dbb7cbc-da22-4b67-8685-b1aea8c4551e",
    "Date": 1707315388,
    "errors": null
}  

{
    "Message": "Quoted conversion is not enabled. Contact your support to activate this feature.",
    "Type": "forbidden_ressource",
    "Id": "cb1a7c79-4ece-4930-9996-9c43b35df3b7",
    "Date": 1707315678,
    "errors": null
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "c1407e47-9146-486d-81b0-54cf9142f2c3",
    "Date": 1720793416.0,
    "errors": {
        "Quote.Amount": "Debited amount or credited amount is required"
    }
}

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "bd657a7e-7250-4d35-a49b-eddd24126e7b",
    "Date": 1720793433.0,
    "errors": {
        "Quote.Amount": "Only one of these fields is required: debited amount or credited amount"
    }
}

{
    "Id": "cvrquote_01J3G082JEQRQ4WGJPSVF5GPS7",
    "CreationDate": 1721745279,
    "ExpirationDate": 1721745579,
    "Status": "ACTIVE",
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "USD",
        "Amount": 1163
    },
    "Fees": {
        "Currency": "GBP",
        "Amount": 100
    },
    "ConversionRateResponse": {
        "ClientRate": 1.2793195,
        "MarketRate": 1.29172
    },
    "Tag": "Created using the Mangopay API Postman collection"
}

{
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "USD"
    },
    "Fees": {
        "Currency": "GBP",
        "Amount": 100
    },
    "Duration": 300,
    "Tag": "Created using the Mangopay API Postman collection"
}