Create a Quoted Conversion between user Wallets

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

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

Body parameters

QuoteId · string · required

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

AuthorId · string · required

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.

DebitedWalletId · string · required

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

CreditedWalletId · string · required

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

Tag · string

Max. length: 255 characters

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

Responses

200 - Succeeded

Id · string

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

The unique identifier of the object.

QuoteId · string

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

Returned null in the case of an instant conversion.

Type · string

The type of transaction.

Nature · string

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.

CreationDate · Unix timestamp

The date and time at which the object was created.

Status · string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

AuthorId · string

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.

DebitedWalletId · string

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

CreditedWalletId · string

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

DebitedFunds · object

Information about the debited funds.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds (the sell currency).

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

During a conversion, (DebitedFunds.Amount - Fees) * MarketRate = CreditedFunds.Amount. 

CreditedFunds · object

Information about the credited funds.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the credited funds (the buy currency).

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

During a conversion, CreditedFunds.Amount = (DebitedFunds.Amount - Fees) * MarketRate. 

Fees · object

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.

Show properties

Currency · string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the fees.

Amount · integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

ResultCode · string

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

ResultMessage · string

The explanation of the result code.

ExecutionDate · Unix timestamp

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

ConversionRateResponse · object

Information about the conversion rate used during the transaction.

Show properties

ClientRate · float

Max. 7 decimal places

The rate including Mangopay’s markup, indicative of the rate invoiced during the billing cycle: ClientRate = MarketRate * (1 - markup). 

The ClientRate fluctuates in line with the MarketRate.

MarketRate · float

Max. 7 decimal places

The rate used to convert funds during a conversion: (DebitedFunds.Amount - Fees) * MarketRate = CreditedFunds.Amount.

The market rate fluctuates in line with FX market dynamics and is common to all platforms for the currency pair.

Tag · string

Max. length: 255 characters

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

Functional errors (ResultCode) are possible on a 200 response. Read more →

---

400 - Quote required for Quoted Conversion

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "ffaf5ad6-d9f1-47bf-832c-ea5da626037e",
    "Date": 1706192320,
    "errors": {
        "QuoteId": "Quote not found"
    }
}  

400 - Quote expired

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "31dc86e1-783e-4e34-94d0-4e1891fd74bb",
    "Date": 1707301282,
    "errors": {
        "QuoteId": "The quote is expired"
    }
}  

400 - Quote already used

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "2b989396-3dc7-4fcf-8a7e-2c6463262633",
    "Date": 1707301113,
    "errors": {
        "QuoteId": "The quote is already consumed"
    }
}  

400 - Credited currency doesn’t match quote

{
    "Message": "Credited currency incompatibility.",
    "Type": "currency_incompatibility",
    "Id": "47ade3b3-0c5d-4c32-ae11-1cfd23720a11",
    "Date": 1707314958,
    "errors": null
}  

400 - Debited currency doesn’t match quote

{
    "Message": "Debited currency incompatibility.",
    "Type": "currency_incompatibility",
    "Id": "f83e073e-287d-4781-bbba-87256dad4aa0",
    "Date": 1707315285,
    "errors": null
}  

400 - Author is not debited wallet owner

{
    "Message": "Author 204071581 is not debited wallet 214818911 owner.",
    "Type": "author_is_not_debited_wallet_owner",
    "Id": "c16cb140-0f02-4c5f-a705-9cfdb11fb499",
    "Date": 1708382645.0,
    "errors": null
}  

400 - Author is not credited wallet owner

{
    "Message": "Author 204071581 is not credited wallet 214818911 owner.",
    "Type": "author_is_not_credited_wallet_owner",
    "Id": "5586bf7e-8e33-4e7a-a140-107f7a9e3a26",
    "Date": 1708382704.0,
    "errors": null
}  

200 - Succeeded

{
    "Id": "cvr_01J3G1FKHQ5NAPM2ZG8RKKD706",
    "QuoteId": "cvrquote_01J3G1FBKHNSB88AJ7RDRCFK9S",
    "Type": "CONVERSION",
    "Nature": "REGULAR",
    "CreationDate": 1721746574,
    "Status": "SUCCEEDED",
    "AuthorId": "user_m_01HSB23417BFG7YXR7E371JSEA",
    "DebitedWalletId": "wlt_m_01HSJTVB0JKMMHXBEJBV6TMF96",
    "CreditedWalletId": "wlt_m_01J3G1CY4VH5FNMSAM8M0S5A64",
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "USD",
        "Amount": 1162
    },
    "Fees": {
        "Currency": "GBP",
        "Amount": 100
    },
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1721746575,
    "ConversionRateResponse": {
        "ClientRate": 1.2787055,
        "MarketRate": 1.2911001
    },
    "Tag": "Created using the Mangopay API Postman collection"
}

REST

{
    "QuoteId": "cvrquote_01HP1H6EK4H39SCQ8WJ349WMBB",
    "AuthorId": "204071581",
    "DebitedWalletId": "204079338",
    "CreditedWalletId": "209408867",
    "Tag": "Created using the Mangopay API Postman collection"
}