Create a Quoted Conversion between Client Wallets

POST

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

POST

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

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/clients/conversions/quoted-conversion \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "QuoteId": "cvrquote_01J475ZRENK67V9A62JCQ6PYVW",
>     "DebitedWalletType": "FEES",
>     "CreditedWalletType": "CREDIT",
>     "Tag": "Created using Mangopay API Collection Postman"
>   }
> }'

1 {
2   "Id": "cvr_01J475ZYZ6WBZK3JK3HSZFXHVN",
3   "QuoteId": "cvrquote_01J475ZRENK67V9A62JCQ6PYVW",
4   "Type": "CONVERSION",
5   "Nature": "REGULAR",
6   "CreationDate": 1722523057,
7   "Status": "SUCCEEDED",
8   "AuthorId": "your-client-id",
9   "DebitedWalletId": "FEES_EUR",
10   "CreditedWalletId": "CREDIT_GBP",
11   "DebitedFunds": {
12     "Currency": "EUR",
13     "Amount": 10
14   },
15   "CreditedFunds": {
16     "Currency": "GBP",
17     "Amount": 8
18   },
19   "ResultCode": "000000",
20   "ResultMessage": "Success",
21   "ExecutionDate": 1722523057,
22   "ConversionRateResponse": {
23     "ClientRate": 0.8352637,
24     "MarketRate": 0.84336
25   },
26   "Tag": "Created using Mangopay API Collection Postman"
27 }

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

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. The [Client Wallets](/api-reference/client-wallets/client-wallet-object) to debit and credit are defined in the conversion. Each quoted conversion requires a dedicated [Quote](/api-reference/quotes/quote-object) 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`).

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.

DebitedWalletTypestringRequired

Allowed values: FEES, CREDIT

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

CreditedWalletTypestringRequired

Allowed values: FEES, CREDIT

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

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.

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.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

Errors

400

Bad Request Error