> For the complete documentation index, see [llms.txt](https://docs.sportradar.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sportradar.com/uof/bet-builder/api/cashout.md).

# Cashout

### Overview&#x20;

The Cashout API enables operators to retrieve the fair probability of the remaining cashout-eligible outcomes of an existing Bet Builder ticket for the purpose of calculating a cashout offer.&#x20;

Using the fair probability returned by the API, operators can apply their own cashout margin and pricing logic to calculate the cashout value presented to their punters.&#x20;

Cashout gives punters greater flexibility to manage an existing Bet Builder ticket as an event progresses. It also enables operators to provide continued engagement with live bets while retaining control over their own cashout pricing and risk-management strategy.&#x20;

No additional configuration is required to use the Cashout API. Operators can integrate directly with the endpoint and apply their own margin to the returned fair probability.&#x20;

### How to use Cashout API&#x20;

1. The customer has an open bet builder and asks to cash out (or you show a live cash-out value throughout the match).&#x20;
2. You call the cash-out endpoint with the selections that are still running in that bet builder (see Section 4 on handling settled selections).&#x20;
3. We return the current fair probability for those selections.&#x20;
4. You derive your cash-out value from the returned fair probability, apply your own margin, and present it to the customer.&#x20;
5. You can poll the endpoint to keep the value current while the customer decides.&#x20;

### Cashout API vs. Calculation API&#x20;

The Cashout API is designed specifically to evaluate existing Bet Builder tickets. As a result, the market lines accessible through the Cashout API may differ from those available through the Calculation or Available Selections APIs.&#x20;

|                                            | Cashout API                                                                                | Calculation APIs                                                                           |
| ------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| Primary use case                           | Calculate fair probability for cashout of an existing Bet Builder ticket                   | Price new Bet Builder combinations and identify selections currently available for betting |
| Active market lines                        | :white\_check\_mark: Available                                                             | :white\_check\_mark: Available                                                             |
| Inactive / temporarily closed market lines | :white\_check\_mark: May remain available if previously offered and still cashout-eligible | :x: Unavailable for new calculations/selections                                            |
| Currently unavailable for cashout          | Excluded from the calculation and identified in the response                               | :x: Unavailable for new calculations/selections                                            |
| Settled selections                         | Excluded from the calculation and identified in the response                               | :x: Unavailable for new calculations/selections                                            |
| Voided / cancelled selections              | Excluded from the calculation and identified in the response                               | :x: Unavailable for new calculations/selections                                            |

&#x20;

### Handling Settled or Cashout-Unavailable Selections&#x20;

The operators are responsible to remove any settled markets before submitting the cashout request. &#x20;

However, the Cashout API is designed to handle changes in selection status without requiring the client to rebuild and resubmit the request.&#x20;

We have 3 different types of cases:&#x20;

* If all selections are eligible for cashout, you can direclty use the fair probabiltiy from the response to calculate the cashout value.&#x20;
* If at least one selection is temporarily not eligible for cashout, please retry the Cashout API later. A selection may not be eligible during a bet stop or when a market is temporarily suspended due to significant changes in the event. These markets would be identified as UNAVAILBLE in the response.&#x20;
* If at least a market is settled, while other markets are eligible for cashout, we will exclude that market and return the fair probability for the remaining eligible selections. These markets would be identified as CLOSED in the response.&#x20;

{% hint style="info" %}
**IMPORTANT**:&#x20;

Operators must verify the settlement result of each CLOSED selection before using the returned probability to proceed with cashout.&#x20;
{% endhint %}

1. **Lost:** If the selection has lost, the entire Bet Builder ticket should be treated as lost and cashout should not proceed.&#x20;
2. **Won:** If the selection has won, cashout can proceed using the fair probability returned for the remaining eligible selections.&#x20;
3. **Voided or Cancelled:** If the selection has been voided or cancelled, the Bet Builder ticket odds must first be recalculated to account for the voided selection. The Void Recalculation API can be used for this purpose. Once the ticket odds have been updated, cashout can proceed using the remaining eligible selections.&#x20;

#### Supported Sports and Markets&#x20;

| Sport       | Cashout Supported |
| ----------- | ----------------- |
| Soccer      | Coming in Q4      |
| Tennis      | Available         |
| Basketball  | Coming in Q4      |
| AM Football | Coming in Q4      |
| Baseball    | Coming in 2027    |
| Ice Hockey  | Coming in 2027    |
| MMA         | Coming in 2027    |
| Cricket     | Coming in 2027    |
| Rugby       | Coming in Q4      |
| Volleyball  | Coming in Q4      |

Cashout are available for all core markets, player markets are not supported now but will come in future releases. Please stay tuned through our release notes for latest updates.&#x20;

### Access & Integration Journey&#x20;

No additional configuration is required to enable the Cashout API. Once integrated, operators can request fair probabilities for existing Bet Builder tickets using the following flow.&#x20;

{% stepper %}
{% step %}

### Submit the Selections to the Cashout API&#x20;

Before making a Cashout request, operators should remove any selections that are already known to be settled or permanently closed. Only submit the relevant selections from the existing Bet Builder ticket.&#x20;

Where possible, we recommend listening to Live Settlement messages to keep the selection status up to date.&#x20;
{% endstep %}

{% step %}

### Calculate the Cashout Value

Use the returned fair probability to calculate the cashout value. Operators need to apply their own cashout margin, pricing rules, risk-management logic, or other commercial adjustments.&#x20;

The Cashout API provides the fair probability only. The operator remains responsible for calculating the final cashout value presented to the punter.&#x20;
{% endstep %}

{% step %}

### Display the Cashout Offer&#x20;

Once the cashout value has been calculated, it can be displayed to the punter.&#x20;

As selection statuses and probabilities can change during a live event, operators should request an up-to-date fair probability whenever a cashout offer is generated or refreshed.&#x20;
{% endstep %}
{% endstepper %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sportradar.com/uof/bet-builder/api/cashout.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
