Skip to main content
POST
/
v2.01
/
{ClientId}
/
conversions
/
instant-conversion
{
    "AuthorId": "user_m_01KGHXXFF6AQZA68MESVQVY7RA",
    "CreditedWalletId": "wlt_m_01KGSJ7GQY0P12EBB6XFAC866C",
    "DebitedWalletId": "wlt_m_01KGSJDM69VNXPKKGH1B3QFVFC",
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "EUR"
    },
    "Fees": {
        "Type": "PERCENTAGE",
        "Value": 700,
        "Currency": "GBP"
    },
    "UserMargin": {
        "Type": "PERCENTAGE",
        "Value": 1.5,
        "Currency": "GBP"
    },
    "Tag": "Created using the Mangopay API Postman collection"
}

{
    "Id": "cvr_01KH3K4ZER63X4KT634TJZHWE1",
    "Type": "CONVERSION",
    "Nature": "REGULAR",
    "CreationDate": 1770721017,
    "Status": "SUCCEEDED",
    "AuthorId": "user_m_01KGHXXFF6AQZA68MESVQVY7RA",
    "DebitedWalletId": "wlt_m_01KGSJDM69VNXPKKGH1B3QFVFC",
    "CreditedWalletId": "wlt_m_01KGSJ7GQY0P12EBB6XFAC866C",
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1067
    },
    "Fees": {
        "Currency": "GBP",
        "Amount": 70
    },
    "RequestedFees": {
        "Type": "PERCENTAGE",
        "Value": 700,
        "Currency": "GBP"
    },
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1770721018,
    "ConversionRateResponse": {
        "ClientRate": 1.13798,
        "MarketRate": 1.1471573,
        "FinalRate": 1.1209103
    },
    "MarginsResponse": {
        "Mangopay": {
            "Type": "PERCENTAGE",
            "Value": 0.8,
            "Amount": 8
        },
        "User": {
            "Type": "PERCENTAGE",
            "Value": 1.5,
            "Amount": 16
        }
    },
    "Tag": "Created using the Mangopay API Postman collection"
}
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).
​
UserMargin
object
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.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.

​
Responses

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
Type
string
The type of transaction.
​
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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, FAILEDThe 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.
​
RequestedFees
object
Information about the Fees sent in the request.
​
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 MarketRate used to convert funds and other indicative rates.
​
MarginsResponse
object
Information about the margins calculated for the transaction.
​
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
Functional errors (ResultCode) are possible on a 200 response. Read more → 
{
    "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": "Debited currency incompatibility.",
    "Type": "currency_incompatibility",
    "Id": "af071186-b891-4e0d-baeb-736c15a757e8",
    "Date": 1699532861,
    "errors": null
}  

{
    "Message": "Credited currency incompatibility.",
    "Type": "currency_incompatibility",
    "Id": "2466e688-5f4f-4dfa-8ebe-97b5608c3dd5",
    "Date": 1699532915,
    "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
}  

{
    "Id": "cvr_01KH3K4ZER63X4KT634TJZHWE1",
    "Type": "CONVERSION",
    "Nature": "REGULAR",
    "CreationDate": 1770721017,
    "Status": "SUCCEEDED",
    "AuthorId": "user_m_01KGHXXFF6AQZA68MESVQVY7RA",
    "DebitedWalletId": "wlt_m_01KGSJDM69VNXPKKGH1B3QFVFC",
    "CreditedWalletId": "wlt_m_01KGSJ7GQY0P12EBB6XFAC866C",
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1067
    },
    "Fees": {
        "Currency": "GBP",
        "Amount": 70
    },
    "RequestedFees": {
        "Type": "PERCENTAGE",
        "Value": 700,
        "Currency": "GBP"
    },
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1770721018,
    "ConversionRateResponse": {
        "ClientRate": 1.13798,
        "MarketRate": 1.1471573,
        "FinalRate": 1.1209103
    },
    "MarginsResponse": {
        "Mangopay": {
            "Type": "PERCENTAGE",
            "Value": 0.8,
            "Amount": 8
        },
        "User": {
            "Type": "PERCENTAGE",
            "Value": 1.5,
            "Amount": 16
        }
    },
    "Tag": "Created using the Mangopay API Postman collection"
}

{
    "AuthorId": "user_m_01KGHXXFF6AQZA68MESVQVY7RA",
    "CreditedWalletId": "wlt_m_01KGSJ7GQY0P12EBB6XFAC866C",
    "DebitedWalletId": "wlt_m_01KGSJDM69VNXPKKGH1B3QFVFC",
    "DebitedFunds": {
        "Currency": "GBP",
        "Amount": 1000
    },
    "CreditedFunds": {
        "Currency": "EUR"
    },
    "Fees": {
        "Type": "PERCENTAGE",
        "Value": 700,
        "Currency": "GBP"
    },
    "UserMargin": {
        "Type": "PERCENTAGE",
        "Value": 1.5,
        "Currency": "GBP"
    },
    "Tag": "Created using the Mangopay API Postman collection"
}