Create a Quoted Conversion between user Wallets

POST

/v2.01/:ClientId/conversions/quoted-conversion

POST

/v2.01/:ClientId/conversions/quoted-conversion

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/conversions/quoted-conversion \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "QuoteId": "cvrquote_01HP1H6EK4H39SCQ8WJ349WMBB",
>     "AuthorId": "204071581",
>     "DebitedWalletId": "204079338",
>     "CreditedWalletId": "209408867",
>     "Tag": "Created using the Mangopay API Postman collection"
>   }
> }'

1 {
2   "Id": "cvr_01KH3JAVX32DNZ2141BFMERP5V",
3   "QuoteId": "cvrquote_01KH3J69K96FXNMQ875PTDJ13A",
4   "Type": "CONVERSION",
5   "Nature": "REGULAR",
6   "CreationDate": 1770720161,
7   "Status": "SUCCEEDED",
8   "AuthorId": "user_m_01KGHXXFF6AQZA68MESVQVY7RA",
9   "DebitedWalletId": "wlt_m_01KGSJDM69VNXPKKGH1B3QFVFC",
10   "CreditedWalletId": "wlt_m_01KGSJ7GQY0P12EBB6XFAC866C",
11   "DebitedFunds": {
12     "Currency": "GBP",
13     "Amount": 1000
14   },
15   "CreditedFunds": {
16     "Currency": "EUR",
17     "Amount": 1067
18   },
19   "Fees": {
20     "Currency": "GBP",
21     "Amount": 70
22   },
23   "RequestedFees": {
24     "Type": "PERCENTAGE",
25     "Value": 700,
26     "Currency": "GBP"
27   },
28   "ResultCode": "000000",
29   "ResultMessage": "Success",
30   "ExecutionDate": 1770720162,
31   "ConversionRateResponse": {
32     "ClientRate": 1.1360925,
33     "MarketRate": 1.1471047,
34     "FinalRate": 1.1190511
35   },
36   "MarginsResponse": {
37     "Mangopay": {
38       "Type": "PERCENTAGE",
39       "Value": 0.96,
40       "Amount": 10
41     },
42     "User": {
43       "Type": "PERCENTAGE",
44       "Value": 1.5,
45       "Amount": 16
46     }
47   },
48   "Tag": "Created using the Mangopay API Postman collection"
49 }

This call triggers a conversion at the rate defined in its quote. The debited funds (sell currency), credited funds (buy currency), and amounts are defined in the quote.

Each quoted conversion requires a dedicated Quote object, linked in the QuoteId.

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.

QuoteIdstringRequired

The unique identifier of the active quote which guaranteed the rate for the conversion.

AuthorIdstringRequired

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.

DebitedWalletIdstringRequired

The unique identifier of the debited wallet (in the sell currency).

CreditedWalletIdstringRequired

The unique identifier of the credited wallet (in the buy currency).

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

Response

Success

Idstring

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

The unique identifier of the object.

QuoteIdstring or null

The unique identifier of the active quote which guaranteed the rate for the conversion.

Returned null in the case of an instant conversion.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.

CreationDateinteger

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

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

AuthorIdstring

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.

DebitedWalletIdstring

The unique identifier of the debited wallet (in the sell currency).

CreditedWalletIdstring

The unique identifier of the credited wallet (in the buy currency).

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.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

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