Skip to navigation
FX conversionsConversions

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.

For conversions between Client Wallets, the Fees cannot be specified.

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.

Path parameters

ClientIdstringRequired
Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.
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.
DebitedFundsobjectRequired
Information about the debited funds.
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.
CreditedFundsobjectRequired

Information about the credited funds – the buy currency.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".

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

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object, such as unique identifiers in your system. To store multiple values, you can serialize them into a single string, for example a JSON object: "{\"id_1\":AB123,\"id_2\":DE456}".