Payout Modifier Settlement Request
Client
→
MTS
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.
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
{
"operatorId": 9985,
operatorId
ID to uniquely identify the client from which the ticket originated, ID is provided to the client by Sportradar, The client is obliged to include it in every ticket
Mandatory
Integer
"content": {
.......
.......
},
content
See Content object description below
Mandatory
Object
"correlationId": "jwo29bsl10",
correlationId
Client defined string to facilitate the request-response pairing, Sportradar is obliged to return the same string in every response
Mandatory
String
"timestampUtc": 1758193723000,
timestampUtc
Timestamp of ticket placement as submitted by the client (Unix time milliseconds format), minimal: 1, maximum: 9223372036854776000
Mandatory
Integer
"operation": "payout-modifier-settlement",
operation
Should be "payout-modifier-settlement" in the case of a Payout-modifier settlement request
Mandatory
String
"version": "3.0"
}
version
Indicates the ticket format version
Mandatory
String
Content object (Payout modifier settlement request)
This object constitutes the ticket itself and includes the following fields:
type
settlementId
reference
settlement
Content object table:
"content": {
Object
"type": "payout-modifier-settlement",
type
Declaration of content type, should be "payout-modifier-settlement" in the case of a Pre-validated ticket placement request
M
String
"settlementId": "SETL3134413498778",
settlementId
Unique ID of this settlement as defined in the client's system, minimal string length = 1, maximum string length = 128
M
String
"reference": "EZ0wq6jxM6WXT
vKtkbUFCzooiGcTqABm",
reference
Specifies the unique identifier of the promotion to identify outcomes that need to be settled, client-defined string, max. string length = 512, min. string length =1.
M
String
"settlement": {
settlement
See settlement description below
M
Object
"type": .....
.....
.....
}
},
1. Settlement ("type": "result") table
"settlement": {
Object
"type": "result",
type
M
String
"result": {
result
M
Object
"type": "win",
type
Enum:
win
lost
void
M
String
"voidFactor": "0.5",
voidFactor
Not present if "type": "void",
Void factor for the selection result, Java regex: ^0(\\.\\d{1,8})?|1(\\.0{1,8})?$
O
String
"deadHeatFactor": "0.5"
}
},
deadHeatFactor
Only present if "type": "win",
Dead-heat factor for the selection result, Java regex: ^0(\\.\\d{1,8})?|1(\\.0{1,8})?$
O
String
2. Settlement ("type": "odds") table
"settlement": {
Object
"type": "odds",
type
M
String
Last updated
Was this helpful?