Create an Instant Conversion between user 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

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

DebitedFunds

object

required

Information about the debited funds.

CreditedFunds

object

required

Information about the credited funds.

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.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.

Responses

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

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.

CreditedFunds

object

Information about the credited funds.

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.

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

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.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.

{
    "Message": "Author 45671234 is not debited wallet 204089031 owner.",
    "Type": "author_is_not_debited_wallet_owner",
    "Id": "5251717e-0965-4e33-a85a-a1042775913f",
    "Date": 1699532783,
    "errors": null
}

{
    "Message": "Author 204068024 is not credited wallet 208282959 owner.",
    "Type": "author_is_not_credited_wallet_owner",
    "Id": "f072dcfd-d02c-4489-835f-7abe0b11fa66",
    "Date": 1699532982,
    "errors": null
}

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "f19eafbd-0310-4814-8f6b-691910b7b4a2",
    "Date": 1707323047,
    "errors": {
        "Fees.Currency": "Provided currency USD does not match debit currency of GBP"
    }
}

{
    "Message": "The currency JPY is not enabled for Forex. Contact your support to activate this feature.",
    "Type": "forex_not_available",
    "Id": "f8701d45-2540-4497-a7ce-4a3bc3181d68",
    "Date": 1699533051,
    "errors": null
}

{
    "Message": "Forex module is not enabled. Contact your support to activate this feature.",
    "Type": "forbidden_ressource",
    "Id": "812b8909-9fb1-45b5-9000-06e8c8d73687",
    "Date": 1699533020,
    "errors": null
}

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Create an Instant Conversion between user Wallets

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses