Get a Conversion Status

Given that a conversion executes asynchronously, to know when the conversion fully completes, it is necessary to retrieve its status. The GET /currency_conversions/{quoteId} method enables you to retrieve the details of a conversion and its updated state. Then, after submitting the conversion quote, you can use this method to poll the quote and determine its status.

Conversions can be in one of three possible states:

  • OPEN: Initial state, Bitso's Conversion Engine is currently processing the conversion; it eventually changes to a final value.
  • COMPLETED: The conversion ended successfully; the funds are now in the target currency.
  • FAILED: The system could not complete the conversion; the funds remain in the original currency. You can retry by getting another quote.

HTTP Request

Header Parameters

You must specify the following authorization parameters in your request:

keySee the section, AuthorizationYes
signatureSee the section, AuthorizationYes
nonceSee the section, AuthorizationYes

Path Parameters

You must specify the following path parameter in your request:

quoteIdIdentifies the quote you want to retrieve. The request-quote call returns it as id.Yes

JSON Response Payload

The endpoint returns a JSON object representing the executed conversion. This object includes the following fields:

Field NameDescriptionType
bookThe book to use.String
createdCreation epoch of the quote in milliseconds.Number
directionIndicates whether it is a buy or a sell.String
estimated slippageAn estimation of the difference between the expected execution rate and the actual execution rate.Object
expiresExpiration epoch of the quote in milliseconds.Number
from_amountNumber of funds you are willing to convert specified in the source currency.String
from_currencyTicker of the source currency.String
idThe quote's unique identifier.String
next_recurrent_eventsIndicates when the next conversions are to take place in milliseconds. Used when conversions are programmed in the Bitso app to occur at specific periods.Object
oidThe order ID.String
paddingThe fee users pay for the conversion.String
rateThe exchange rate Bitso offers for the conversion.String
rate_currencyTicker of the currency in which the conversion rate is expressed.String
statusThe conversion's state. Possible values: open, completed, and failed.String
to_amountNumber of funds you expect to receive as a product of the conversion specified in the target currencyString
to_currencyTicker of the target currency.String

The following response object exemplifies the JSON object returned: