Conversions

View a Conversion

Changed on
<Note icon="fa-regular fa-circle-info"> **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 <a href="/api-reference/overview/data-availability-periods">Data availability periods</a> article. </Note>

View a Conversion

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

get/v2.01/{ClientId}/conversions/{ConversionId}

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/conversions/{ConversionId}
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

ConversionIdstring required

The unique identifier of the conversion.

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

QuoteIdstring nullable

The unique identifier of the active quote which guaranteed the rate for the conversion.

Returned null in the case of an instant conversion.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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

Unix timestamp (UTC) of the date and time the object was created.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

AuthorIdstring

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.

DebitedWalletIdstring

The unique identifier of the debited wallet (in the sell currency).

CreditedWalletIdstring

The unique identifier of the credited wallet (in the buy currency).

ResultCodestring

The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

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.

Tagstring

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

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id view_conversion removed and replaced with conversions_view_conversion