Cash-out Response
Client
←
MTS
Cash-out response types
Cash-out Inform Reply (operation "cashout-inform-reply") is the response to the Cash-out Inform request.
Cashout Build Reply (operation "cashout-build-reply") is the response to the Cash-out Build request.
Cash-out Placement Reply (operation "cashout-placement-reply") is the response to the Cash-out Placement request.
The "ticket-cashout" operation and "cashout-reply" content type will be deprecated, but are currently still used to maintain compatibility. They will be returned if the "ticket-cashout" operation and "cashout" content type were sent as a request.
For an overview of requests and responses, please see Cash-out Requests.
Envelope and Content table:
The envelope provides the content's (Cash-out response) context and contains the following fields ( besides Content):
correlationId
timestampUtc
operation
version
content
See Content object description below
M
Object
correlationId
Client defined string to facilitate the request-response pairing, Sportradar is obliged to return the same string in every response
M
String
timestampUtc
Timestamp of ticket placement as submitted by the client (Unix time in milliseconds format), minimal: 1, maximum: 9223372036854776000
M
Integer
operation
Declaration of ticket content type, should be "ticket-cashout" in case of Cash-out response
M
String
version
Indicates the ticket format version
M
String
}
Please note that in the case of major ticket errors or internal system errors, the content object has a different structure and contains "type": "error-reply". For description, see Error-reply Response.
1. Content object (cashout-inform-reply)
The Content object includes the following fields:
type
cashoutId
signature
status
ticketId
code
message
Content object table:
Object
type
Declaration of content type, should be "cashout-inform-reply"
or "error-reply" in the case of major ticket errors or internal system errors (see also Error-reply Response).
M
String
cashoutId
ID from the corresponding request, minimal string length = 1, maximum string length = 128
O
String
signature
String calculated and sent by MTS to be used as a proof that the response has actually been provided by MTS, minimal string length = 1, maximum string length = 128
M
String
status
Request outcome, enumerator:
accepted
rejected
M
String
ticketId
ID of the initial ticket (defined by client) which is to be affected with this cash-out
M
String
code
Cash-out response code, see list of codes below
M
Integer
message
Readable ticket response validation code, minimal string length = 1, maximum string length = 128
O
String
}
2. Content object (cashout-build-reply)
The Content object includes the following fields:
type
cashoutId
signature
status
ticketId
code
message
ltd
cashout
endCustomerSuggestions
channelSuggestions
betDetails
exchangeRate
Content object table:
Object
type
Declaration of content type, should be "cashout-build-reply"
or "error-reply" in the case of major ticket errors or internal system errors (see also Error-reply Response).
M
String
cashoutId
ID from the corresponding request, minimal string length = 1, maximum string length = 128
O
String
signature
String calculated and sent by MTS to be used as a proof that the response has actually been provided by MTS, minimal string length = 1, maximum string length = 128
M
String
status
Request outcome, enumerator:
accepted
rejected
O
ticketId
ID of the initial ticket (defined by client) which is to be affected with this cash-out
M
String
code
Cash-out response code, see list of codes below
M
Integer
message
Readable ticket response validation code, minimal string length = 1, maximum string length = 128
O
String
ltd
Live time delay suggestion
O
Object
modelSuggestedLtd
Action suggested by the AI LTD model, enum:
Delay (currently the only option implemented)
Skip
None
O
String
configuredLtd
Configured LTD calculated from event coverage or explicit LTD setting, all data is configured in the MTS Console, min: 0, max: 15
O
Integer
suggestedLtd
Suggested LTD calculated from event data latency AI model, min: 0, max: 15
O
Integer
accountLbsLtdOffset
LTD offset derived from account (punter) Late Bet Score, min: 0, max: 15
O
Integer
liveSelectionLtdOffset
LTD offset derived from the number of live selections, configured in MTS Console (default: -2 seconds in the case of 3 or more live selections),
must be less than zero or zero
O
Integer
appliedLtd
MTS recommended LTD, calculated from: max of configured and suggested + account offset + live selection offset, min: 0, max: 15
O
Integer
},
cashout
Cashout suggestion
O
Object
cashoutType
Enum:
ticket
bet
O
String
cashoutId
Unique cash-out ID from the client's system, min length 1, max length 128
O
String
maxPayout
Current maximum potential ticket win (cashout cannot be greater that this),
Array of Payout With Source objects, min. number =1, max. number = 5, (for description, see below)
O
Array
fairCashout
Fair cashout calculation: Fair Cashout Value = Σ [Combination Stake × Combination Odds × Combination Probability]. Array of Payout With Source objects, min. number =1, max. number = 5, (for description, see below)
O
Array
cashout
Calculation: Fair Cashout is used as the foundation and adjusted using additional margin factors and compensation factors (configurable in the Insight Tech UI). Array of Payout With Source objects, min. number =1, max. number = 5, (for description, see below)
O
Array
},
endCustomerSuggestions
O
Object
endCustomer
Data about client's end-customer (bettor)
M
Object
id
End customer's unique ID (in client's system). The same as included in the original ticket.
M
String
confidence
End customer's suggested CCF, Java regex: ^\d{1,8}(\.\d{1,8})?$
O
String
appliedConfidence
Calculated end-customer (punter) CCF
O
String
suggestedConfidence
AI model suggested end-customer (punter) CCF
O
String
suggestedLateBetScore
AI model suggested end-customer (punter) LBS
O
String
suggestedMarkerScore
AI model suggested end-customer (punter) Marker Score
O
String
suggestedBotScore
AI model suggested end-customer (punter) Bot Score
O
String
betDetails
O
Array
betId
Unique bet id (in the client's system), minimal string length = 1, maximum length = 128
O
String
payout
Sum of previous payouts on the bet, min no. of array items = 1, max no. = 5 For object description, see Payout With Source object
O
Array
settledPercentage
Percentage of currently settled stake, Java regex: ^0(\.\d{1,8})?$
O
String
Payout With Source object
The Payout With Source object contains the following fields:
type
amount
currency
source traceId
Payout With Source object table :
{
type
Enum:
cash
withheld
M
String
amount
String pattern: 1 up to 8 digits, optionally followed by a decimal point and 1 up to 8 digits, Java regex: ^\\d{1,8}(\\.\\d{1,8})?$
M
String
currency
3 or 4 letter currency code, BTC and mBTC are also supported (4 letters only apply to mBTC). For more details please check https://www.iso.org/iso-4217-currency-codes.html
M
String
source
Enum:
cash
bonus
odds-boost
cancel
cashout
ext-settlement
manual-cancel
manual-cashout
M
String
traceId
A string to help identify the source of operation/action/state
Minimal string length = 1, maximum length = 128
O
String
Build Reply Selection Detail object
The Build Reply Selection Detail object contains the following fields:
selection
appliedEventRating
suggestedEventRating
configuredLtd
suggestedLtd
appliedMarketFactor
currentProbability
currentResult
Build Reply Selection Detail object table :
selection
A selection that was included in the Ticket Placement Request is returned here, however included can be only selections of "type":"uf" or "type":"external" or "type":"uf-custom-bet"
M
Object
appliedEventRating
Applied event rating for the selection
O
Integer
suggestedEventRating
Suggested event rating for the selection
O
Integer
configuredLtd
Configured LTD calculated from event coverage or explicit LTD setting, min. = 0, max. = 15
O
Integer
suggestedLtd
Suggested LTD calculated from event data latency mode, min. = 0, max. = 15
O
Integer
appliedMarketFactor
Applied market factor for the selection, Java regex: ^0(\\.\\d{1,8})?|1(\\.0{1,8})?$
O
String
currentProbability
Current probabilities for the selection
O
Object
type
Enum:
win
push
M
String
win
Java regex: ^0(\\.\\d{1,8})?|1(\\.0{1,8})?$
M
String
halfWin
Not present if "type": "win", Java regex: ^0(\\.\\d{1,8})?|1(\\.0{1,8})?$
M Only if "type": "push"
String
halfWin
Not present if "type": "win", Java regex: ^0(\\.\\d{1,8})?|1(\\.0{1,8})?$
M Only if "type": "push"
String
halfLose
Not present if "type": "win", Java regex: ^0(\\.\\d{1,8})?|1(\\.0{1,8})?$
M Only if "type": "push"
String
currentResult
Current result for the selection
O
Object
type
Enum:
unsettled
win
lost
void
cashout
cancel
M
String
voidFactor
Only present if "type": "win" or "type": "lost", Void factor for the selection result, Java regex: ^0(\\.\\d{1,8})?|1(\\.0{1,8})?$
O
String
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
3. Content object (cashout-placement-reply)
The Content object includes the following fields:
type
cashoutId
signature
status
ticketId
code
message
Content object table:
type
SDeclaration of content type, should be "cashout-placement-reply"
or "error-reply" in the case of major ticket errors or internal system errors (see also Error-reply Response)
M
String
cashoutId
ID from the corresponding request, minimal string length = 1, maximum string length = 128
O
String
signature
String calculated and sent by MTS to be used as a proof that the response has actually been provided by MTS, minimal string length = 1, maximum string length = 128
M
String
status
Request outcome, enum:
accepted
rejected
M
String
ticketId
ID of the initial ticket (defined by client) which is to be affected with this cash-out
M
String
code
Cash-out response code, see list of codes below
M
Integer
message
Readable ticket response validation code, minimal string length = 1, maximum string length = 128
O
String
Cash-out response codes
For general validation codes , please refer to Validation codes.
Transaction processed
Client (bookmaker) not found
Cash-out disabled for particular client (bookmaker) or Limit ID
Ticket not found
Ticket rejected
Ticket version lower than 3.0
Requested cash-out is lower than the minimum allowed amount
Requested cash-out exceeds the maximum allowed amount
Bet ID not found
Ticket has been already manually settled
Cash-out factor is outside the allowed range of 0-100%
Cash-out factor is lower than existing (when the cash-out factor is lower than the previous one)
Conflicting previous cash-out (bet/ticket level)
Operator (Limit ID) not authorised to use the cash-out validation feature (cashout-placement)
Operator (Limit ID) not authorised to use the cash-out API feature
Cash-out settings not found for Limit ID
Cash-out currency was not found in the transaction
Cash-out calculation failed due to internal or upstream error
Cash-out calculation failed due to internal or upstream error
Selection has unsupported event status
Probabilities not found for selection
Ticket external selections are not allowed
Custom Bet is currently not supported
Market suspended (offer status inactive, no PAPI fallback)
Invalid selection status (PAPI cashout_status)
Custom Bet probabilities not received
Internal system error
Last updated
Was this helpful?