Create a Quote

POST

/v2.01/:ClientId/conversions/quote

POST

/v2.01/:ClientId/conversions/quote

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/conversions/quote \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "CreditedFunds": {
>       "Currency": "EUR"
>     },
>     "DebitedFunds": {
>       "Amount": 1000,
>       "Currency": "GBP"
>     },
>     "Duration": 300,
>     "Fees": {
>       "Currency": "GBP",
>       "Type": "PERCENTAGE",
>       "Value": 700
>     },
>     "Tag": "Created using the Mangopay API Postman collection",
>     "UserMargin": {
>       "Currency": "GBP",
>       "Type": "PERCENTAGE",
>       "Value": 1.5
>     }
>   }
> }'

1 {
2   "Id": "cvrquote_01KH3J69K96FXNMQ875PTDJ13A",
3   "CreationDate": 1770720011,
4   "ExpirationDate": 1770720311,
5   "Status": "ACTIVE",
6   "DebitedFunds": {
7     "Currency": "GBP",
8     "Amount": 1000
9   },
10   "CreditedFunds": {
11     "Currency": "EUR",
12     "Amount": 1067
13   },
14   "Fees": {
15     "Currency": "GBP",
16     "Amount": 70
17   },
18   "RequestedFees": {
19     "Type": "PERCENTAGE",
20     "Value": 700,
21     "Currency": "GBP"
22   },
23   "ConversionRateResponse": {
24     "ClientRate": 1.1360925,
25     "MarketRate": 1.1471047,
26     "FinalRate": 1.1190511
27   },
28   "MarginsResponse": {
29     "Mangopay": {
30       "Type": "PERCENTAGE",
31       "Value": 0.96,
32       "Amount": 10
33     },
34     "User": {
35       "Type": "PERCENTAGE",
36       "Value": 1.5,
37       "Amount": 16
38     }
39   },
40   "Tag": "Created using the Mangopay API Postman collection"
41 }

This call guarantees a conversion rate for a quoted conversion.

If the quote is for a client wallet conversion then the quote:

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)

This call guarantees a conversion rate for a quoted conversion. If the quote is for a client wallet conversion then the quote: - 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`)

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

Quote for User WalletsobjectRequired

Request body for creating a Quote intended to guarantee a rate for a conversion between user wallets. Includes optional Fees and UserMargin parameters. Use this variant when the corresponding conversion will be a user-wallet-to-user-wallet conversion.

Quote for Client WalletsobjectRequired

Request body for creating a Quote intended to guarantee a rate for a client-wallet conversion. Fees must not be sent (the conversion attempt will return a 400 if its QuoteId includes fees) and UserMargin is disregarded by the conversion if sent.

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

ExpirationDateinteger

Unix timestamp (UTC) of the date and time the quote expires and can no longer be used.

Statusstring

Returned values: ACTIVE, EXPIRED

The 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.

DebitedFundsobject

Information about the debited funds.

CreditedFundsobject

Information about the credited funds.

Feesobject

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.

RequestedFeesobject

Information about the Fees sent in the request.

ConversionRateResponseobject

Information about the MarketRate used to convert funds and other indicative rates.

MarginsResponseobject

Information about the margins calculated for the transaction.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

Errors

400

Bad Request Error

403

Forbidden Error