Create an Instant Conversion between user Wallets

POST

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

POST

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

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/conversions/instant-conversion \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "AuthorId": "user_m_01KGHXXFF6AQZA68MESVQVY7RA",
>     "CreditedFunds": {
>       "Currency": "EUR"
>     },
>     "CreditedWalletId": "wlt_m_01KGSJ7GQY0P12EBB6XFAC866C",
>     "DebitedFunds": {
>       "Amount": 1000,
>       "Currency": "GBP"
>     },
>     "DebitedWalletId": "wlt_m_01KGSJDM69VNXPKKGH1B3QFVFC",
>     "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": "cvr_01KH3K4ZER63X4KT634TJZHWE1",
3   "Type": "CONVERSION",
4   "Nature": "REGULAR",
5   "CreationDate": 1770721017,
6   "Status": "SUCCEEDED",
7   "AuthorId": "user_m_01KGHXXFF6AQZA68MESVQVY7RA",
8   "DebitedWalletId": "wlt_m_01KGSJDM69VNXPKKGH1B3QFVFC",
9   "CreditedWalletId": "wlt_m_01KGSJ7GQY0P12EBB6XFAC866C",
10   "DebitedFunds": {
11     "Currency": "GBP",
12     "Amount": 1000
13   },
14   "CreditedFunds": {
15     "Currency": "EUR",
16     "Amount": 1067
17   },
18   "Fees": {
19     "Currency": "GBP",
20     "Amount": 70
21   },
22   "RequestedFees": {
23     "Type": "PERCENTAGE",
24     "Value": 700,
25     "Currency": "GBP"
26   },
27   "ResultCode": "000000",
28   "ResultMessage": "Success",
29   "ExecutionDate": 1770721018,
30   "ConversionRateResponse": {
31     "ClientRate": 1.13798,
32     "MarketRate": 1.1471573,
33     "FinalRate": 1.1209103
34   },
35   "MarginsResponse": {
36     "Mangopay": {
37       "Type": "PERCENTAGE",
38       "Value": 0.8,
39       "Amount": 8
40     },
41     "User": {
42       "Type": "PERCENTAGE",
43       "Value": 1.5,
44       "Amount": 16
45     }
46   },
47   "Tag": "Created using the Mangopay API Postman collection"
48 }

This call triggers an immediate conversion at the market rate, of the debited funds to the credited wallet at the market rate. A quote is not required for an instant conversion.

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.

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

DebitedFundsobjectRequired

Information about the debited funds.

CreditedFundsobjectRequired

Information about the credited funds.

FeesobjectOptional

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

UserMarginobjectOptional

Information about an indicative margin your platform can calculate and charge to the user after conversion. These values are used to calculate the ConversionRateResponse.FinalRate and the MarginsResponse.User in the API response.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

Response

Success

IdstringOptional

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

The unique identifier of the object.

TypestringOptional

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

NaturestringOptional

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.

CreationDateintegerOptional

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

StatusstringOptional

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

AuthorIdstringOptional

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.

DebitedWalletIdstringOptional

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

CreditedWalletIdstringOptional

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

DebitedFundsobjectOptional

Information about the debited funds.

CreditedFundsobjectOptional

Information about the credited funds.

FeesobjectOptional

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.

RequestedFeesobjectOptional

Information about the Fees sent in the request.

ResultCodestringOptional

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

ResultMessagestringOptional

The explanation of the result code.

ExecutionDateintegerOptional

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.

ConversionRateResponseobjectOptional

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

MarginsResponseobjectOptional

Information about the margins calculated for the transaction.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

Errors

400

Bad Request Error

403

Forbidden Error