Execute a Conversion Quote
The PUT /api/v4/currency_conversions/{quote_id} method enables you to execute a conversion quote within the 30-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.
It is impossible to cancel the execution of a conversion quote once you have submitted it.
Submitting a quote does not guarantee its executionExecution is asynchronous. A successful response from this endpoint only means that Bitso received the quote and submitted it for execution. It does not mean the conversion was executed, and it does not guarantee that it will be.
After you submit a quote, the conversion can still end in the
failedstatus, for example, when the order books do not have enough liquidity at the quoted rate or the market moves between the quote and its execution. This endpoint does not return an error when that happens. To learn the final outcome, poll the conversion status with the returnedoiduntil it reachescompletedorfailed.
Liquidity and Conversion Size
Whether Bitso can quote and execute a conversion depends on the liquidity available in the order books and on market volatility at that moment. For this reason, there is no fixed maximum amount for a conversion, and an amount that converts successfully at one moment may not convert at another.
The larger the amount, the higher the risk that:
- The quote request is rejected with the error
0367(Unable to generate quote at the present time). - The quote is submitted, but the conversion ends in the
failedstatus.
We recommend that your integration:
- Always confirm the final status of each conversion with the conversion status endpoint before treating it as done.
- Handle the
failedstatus by requesting a new quote, which reflects current market conditions and can have a different rate, or by splitting the amount into smaller conversions. - Considers Bitso's OTC desk, such as the RFQ service, for large amounts.
HTTP Request
Header Parameters
You must specify the following authentication parameters in your request:
| Parameter | Description | Required |
|---|---|---|
key | See the section, Authentication | Yes |
signature | See the section, Authentication | Yes |
nonce | See the section, Authentication | Yes |
Path Parameters
You must specify the following path parameter in your request:
| Parameter | Description | Required |
|---|---|---|
quote_id | Identifies the quote you want to execute. The request-quote call returns it as id. | Yes |
JSON Response Payload
A successful call returns a JSON object representing the submitted conversion. The following response object exemplifies the JSON object returned:
{
"success": true,
"payload": {
"oid": "7316"
}
}The value of the oid variable is the path parameter (conversion_id) you need to use when getting-a-conversion-status.
The meaning of the response object field is as follows:
| Field Name | Description | Type |
|---|---|---|
oid | The conversion's unique ID. | String |
Updated 11 days ago
