Create an Instant Conversion between Client Wallets

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.

Body parameters

DebitedWalletType · string · required

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.

DebitedFunds · object · required

Information about the debited funds.

Show properties

Currency · string · required

Allowed 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 · required

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. 

CreditedWalletType · string · required

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.

CreditedFunds · object · required

Information about the credited funds.

Show properties

Currency · string · required

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

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

The unique identifier of the object.

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. 

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.

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

---

200 - Succeeded

{
    "Id": "cvr_01J47619CVSEVWZE480Z245AMB",
    "Type": "CONVERSION",
    "Nature": "REGULAR",
    "CreationDate": 1722523100,
    "Status": "SUCCEEDED",
    "AuthorId": "client-id",
    "DebitedWalletId": "FEES_EUR",
    "CreditedWalletId": "FEES_USD",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5000
    },
    "CreditedFunds": {
        "Currency": "USD",
        "Amount": 5399
    },
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1722523101,
    "ConversionRateResponse": {
        "ClientRate": 1.071231,
        "MarketRate": 1.07987
    },
   "Tag": "Created using Mangopay API Collection Postman"
}

REST

{
    "DebitedWalletType": "FEES",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 5000
    },
    "CreditedWalletType": "FEES",
    "CreditedFunds": {
        "Currency": "USD"
    },
   "Tag": "Created using Mangopay API Collection Postman"
}