View a Conversion

All conversions returned by this endpoint contain the QuoteId parameter. For instant conversions, it is null.

Note – Conversion data retained for 13 months

An API call to retrieve a conversion whose CreationDate is older than 13 months may return 404 Not Found.

For more information, see the Data availability periods article.

Path parameters

ConversionId · string

The unique identifier of the conversion.

Responses

200 - Instant conversion

Id · string

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

200 - Quoted conversion

Id · string

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

200 - Instant conversion

{
    "Id": "cvr_01HQ1QSE554QW3HYQ9DMVF0D5H",
    "QuoteId": null,
    "Type": "CONVERSION",
    "Nature": "REGULAR",
    "CreationDate": 1708381747,
    "Status": "SUCCEEDED",
    "AuthorId": "204071581",
    "DebitedWalletId": "204844308",
    "CreditedWalletId": "204079338",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 10000
    },
    "CreditedFunds": {
        "Currency": "GBP",
        "Amount": 8468
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 100
    },
    "ResultCode": "000000",
    "ResultMessage": "Success",
    "ExecutionDate": 1708381747,
    "ConversionRateResponse": {
        "ClientRate": 0.8468,
        "MarketRate": 0.8554
    },
    "Tag": "Created using the Mangopay API Postman collection"
}  

PHP

<?php 

require_once '../vendor/autoload.php';

use MangoPay\MangoPayApi;
use MangoPay\Libraries\ResponseException as MGPResponseException;
use MangoPay\Libraries\Exception as MGPException;

$api = new MangoPayApi();

$api->Config->ClientId = 'client-id';
$api->Config->ClientPassword = 'api-key';
$api->Config->TemporaryFolder = '../tmp/';
$api->Config->DebugMode = false;

try { 
    $response = $api->Conversions->GetConversion("cvr_01JE92STKQNGZ2W67D224J4S2R");

    print_r($response);
} catch(MGPResponseException $e) {
    print_r($e);
} catch(MGPException $e) {
    print_r($e);
}