# Payout Modifier Settlement Request

<table><thead><tr><th width="115.0677490234375" align="center">Source</th><th width="55.919189453125" align="center"></th><th width="114.782958984375" align="center">Destination</th></tr></thead><tbody><tr><td align="center"><strong>Client</strong></td><td align="center"><strong>→</strong></td><td align="center"><strong>MTS</strong></td></tr></tbody></table>

This type of request settles selections that are eligible for Payout Modifier changes. The Payout Modifier can set the result or change the effective odds of an underlying selection. The request contains a reference to the corresponding Payout Modifier promotion.

When such a request is received, all transactions containing that particular Payout Modifier option (identified by matching the reference) will be updated to reflect the received settlement. Note that the Payout Modifier Settlement will only be applied if the resulting odds are more favorable to the punter.

If a transaction is fully settled and the Payout Modifier has not been received within 12 hours (configurable) of transaction settlement, no further early payout "corrections" will be accepted.

<br>

**Envelope and Content table:**

The envelope provides the content's (Payout modifier settlement request) context and contains the following fields (besides Content):

* operatorId
* correlationId
* timestampUtc
* operation
* version

<table data-full-width="true"><thead><tr><th width="351">Example</th><th width="147.7620849609375">Field Name</th><th>Field Description</th><th width="100">Mandatory/ Optional</th><th width="100">Data Type</th></tr></thead><tbody><tr><td><pre><code>{
</code></pre></td><td><br></td><td><br></td><td><br></td><td><br></td></tr><tr><td><pre><code>  "operatorId": 9985,
</code></pre></td><td>operatorId</td><td>ID to uniquely identify the client from which the ticket originated,<br>ID is provided to the client by Sportradar,<br>The client is obliged to include it in every ticket</td><td>Mandatory</td><td>Integer</td></tr><tr><td><pre><code>  "content": {
        .......
        .......
         },
</code></pre></td><td>content</td><td>See Content object description below</td><td>Mandatory</td><td>Object</td></tr><tr><td><pre><code>  "correlationId": "jwo29bsl10",
</code></pre></td><td>correlationId</td><td>Client defined string to facilitate the request-response pairing,<br>Sportradar is obliged to return the same string in every response</td><td>Mandatory</td><td>String</td></tr><tr><td><pre><code>  "timestampUtc": 1758193723000,
</code></pre></td><td>timestampUtc</td><td>Timestamp of ticket placement as submitted by the client (Unix time milliseconds format),<br>minimal: 1,<br>maximum:  9223372036854776000</td><td>Mandatory</td><td>Integer</td></tr><tr><td><pre data-overflow="wrap"><code>  "operation": "payout-modifier-settlement",
</code></pre></td><td>operation</td><td>Should be "payout-modifier-settlement" in the case of a Payout-modifier settlement request</td><td>Mandatory</td><td>String</td></tr><tr><td><pre><code>  "version": "3.0"
}
</code></pre></td><td>version</td><td>Indicates the ticket format version</td><td>Mandatory</td><td>String</td></tr></tbody></table>

<br>

### &#x20;Content object (Payout modifier settlement request) <a href="#mtspayoutmodifiersettlementrequest-v3.0-contentobject-payoutmodifiersettlementrequest" id="mtspayoutmodifiersettlementrequest-v3.0-contentobject-payoutmodifiersettlementrequest"></a>

This object constitutes the ticket itself and includes the following fields:

* type
* settlementId
* reference
* settlement

<br>

**Content object table:**

<table data-full-width="true"><thead><tr><th width="351">Example</th><th width="143.829833984375">Field Name</th><th>Field Description</th><th width="100">Mandatory/ Optional</th><th width="100">Data Type</th></tr></thead><tbody><tr><td><pre><code>"content": {
</code></pre></td><td><br></td><td><br></td><td><br></td><td>Object</td></tr><tr><td><pre data-overflow="wrap"><code>    "type": "payout-modifier-settlement",
</code></pre></td><td>type</td><td>Declaration of content type, should be "payout-modifier-settlement" in the case of a Pre-validated ticket placement request</td><td>M</td><td>String</td></tr><tr><td><pre data-overflow="wrap"><code>    "settlementId": "SETL3134413498778",
</code></pre></td><td>settlementId</td><td>Unique ID of this settlement as defined in the client's system, <br>minimal string length = 1,<br>maximum string length = 128</td><td>M</td><td>String</td></tr><tr><td><pre><code>    "reference": "EZ0wq6jxM6WXT
</code></pre><pre><code>vKtkbUFCzooiGcTqABm",
</code></pre></td><td>reference</td><td>Specifies the unique identifier of the promotion to identify outcomes that need to be settled, <br>client-defined string,<br>max. string length = 512,<br>min. string length =1.</td><td>M</td><td>String</td></tr><tr><td><pre><code>    "settlement": {
</code></pre></td><td>settlement</td><td>See settlement description below</td><td>M</td><td>Object</td></tr><tr><td><pre><code>         "type": .....
         .....
         .....
     }
 },
</code></pre></td><td><br></td><td><br></td><td><br></td><td><br></td></tr></tbody></table>

**1. Settlement ("type": "result") table**

<table data-full-width="true"><thead><tr><th width="351">Example</th><th width="185.7916259765625">Field Name</th><th>Field Description</th><th width="100">Mandatory/ Optional</th><th width="100">Data Type</th></tr></thead><tbody><tr><td><pre><code>"settlement": {
</code></pre></td><td><br></td><td><br></td><td><br></td><td>Object</td></tr><tr><td><pre><code>     "type": "result",
</code></pre></td><td>type</td><td><br></td><td>M</td><td>String</td></tr><tr><td><pre><code>     "result": {
</code></pre></td><td>result</td><td><br></td><td>M</td><td>Object</td></tr><tr><td><pre><code>        "type": "win",
</code></pre></td><td><ul><li>type</li></ul></td><td><p>Enum:</p><ul><li>win</li><li>lost</li><li>void</li></ul></td><td>M</td><td>String</td></tr><tr><td><pre><code>        "voidFactor": "0.5",
</code></pre></td><td><ul><li>voidFactor</li></ul></td><td><p>Not present if "type": "void",</p><p>Void factor for the selection result,<br>Java regex:<br>^0(\\.\\d{1,8})?|1(\\.0{1,8})?$</p></td><td>O</td><td>String</td></tr><tr><td><pre><code>        "deadHeatFactor": "0.5"

```
    }
```

}, </code></pre></td><td><ul><li>deadHeatFactor</li></ul></td><td><p>Only present if "type": "win",</p><p>Dead-heat factor for the selection result,<br>Java regex:<br>^0(\\.\d{1,8})?|1(\\.0{1,8})?$</p></td><td>O</td><td>String</td></tr></tbody></table>

**2. Settlement ("type": "odds") table**

<table data-full-width="true"><thead><tr><th width="350.79339599609375">Example</th><th width="182.5711669921875">Field Name</th><th>Field Description</th><th width="100">Mandatory/ Optional</th><th width="100">Data Type</th></tr></thead><tbody><tr><td><pre><code>"settlement": {
</code></pre></td><td><br></td><td><br></td><td><br></td><td>Object</td></tr><tr><td><pre><code>     "type": "odds",
</code></pre></td><td>type</td><td><br></td><td>M</td><td>String</td></tr><tr><td><pre><code>     "odds": {
      ......
      ......
}, 
</code></pre></td><td>odds</td><td>See <a href="../ticket-placement-request#mtsticketplacementrequest-v3.0-betsbetsarray">odds description</a></td><td>M</td><td>Object</td></tr></tbody></table>