Execute a Conversion

The PUT /currency_conversions/{quoteId} method enables you to execute a conversion quote within the 20-second expiration limit. You use the value of the variable id returned by the request-quote call to submit the conversion to Bitso's Conversion Engine. After you submit a conversion, it starts executing asynchronously.

HTTP Request

PUT https://sandbox.bitso.com/api/v3/currency_conversions/{quoteId}

Header Parameters

You must specify the following authorization parameters in your request:

Parameter	Description	Required
`key`	See the section, Authorization	Yes
`signature`	See the section, Authorization	Yes
`nonce`	See the section, Authorization	Yes

Path Parameters

You must specify the following path parameter in your request:

Parameter	Description	Required
`quoteId`	Identifies the quote you want to execute. The request-quote call returns it as `id`.	Yes

Body Parameters

The endpoint does not require any body parameters. However, as shown below, you must send an empty JSON object in your request body. Otherwise, the service throws an error.

{}

JSON Response Payload

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

Field Name	Description	Type
`book`	The book to use.	String
`created`	Creation epoch of the quote in milliseconds.	Number
`direction`	Indicates whether it is a buy or a sell.	String
`estimated slippage`	An estimation of the difference between the expected execution rate and the actual execution rate.	Object
`expires`	Expiration epoch of the quote in milliseconds.	Number
`from_amount`	Number of funds you are willing to convert specified in the source currency.	String
`from_currency`	Ticker of the source currency.	String
`id`	The quote's unique identifier.	String
`next_recurrent_events`	Indicates 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
`oid`	The order ID.	String
`padding`	The fee users pay for the conversion.	String
`rate`	The exchange rate Bitso offers for the conversion.	String
`rate_currency`	Ticker of the currency in which the conversion rate is expressed.	String
`status`	The conversion's state. Possible values: open, completed, and failed.	String
`to_amount`	Number of funds you expect to receive as a product of the conversion specified in the target currency.	String
`to_currency`	Ticker of the target currency.	String

The following response object exemplifies the JSON object returned:

{
   "success":true,
   "payload":{
      "id":"FNMNZDOj",
      "from_amount":"2000.00000000",
      "from_currency":"mxn",
      "to_amount":"107.23505969",
      "to_currency":"usd",
      "estimated_slippage":{
         "level":"normal",
         "message":"",
         "value":"0.00"
      },
      "created":1678483859671,
      "expires":1678483889671,
      "rate":"18.65",
      "rate_currency":"mxn",
      "padding":"0.008",
      "direction":"buy",
      "book":"btc_mxn",
      "status":"open",
      "oid":"FNMNZDOj",
      "next_recurrent_events":{
         "DAILY":1678570259671,
         "WEEKLY":1679088659671,
         "MONTHLY":1681158659671
      }
   }
}