External Settlement Request

Source
Destination

Client

MTS

To settle a ticket (or a bet), the operator must send settlement information to MTS in an External settlement request, including the total win amount (between 0 and the maximum payout). A Settlement request must be sent within 30 days of the “expSettleTime” value. The ticket (or bet) will be automatically settled as lost if not received. In the case of multiple selections, the latest expSettleTime value is considered.

Envelope and Content table:

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

  • operatorId

  • correlationId

  • timestampUtc

  • operation

  • version

Example
Field Name
Field Description
Mandatory/ Optional
Data Type

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

M

Integer

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-ext-settlement" in case of External settlement request

M

String

version

Indicates the ticket format version

M

String

}

Content object (External settlement request)

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

  • type

  • settlementId

  • details

Content object table:

Example
Field Name
Field Description
Mandatory/ Optional
Data Type

Object

type

Declaration of content type, should be "ext-settlement" in case of External settlement request

M

String

settlementId

Unique ID of this particular settlement request in client's system, referenced in eventual ack message, minimal string length = 1, maximum string length = 128

M

String

details

Settlement details - additional information related to the settlement

M

Object

  • type

Settlement can relate either to a ticket or a bet, enumerator:

  • ticket

  • bet

M

String

  • ticketId

ID of the original ticket that is to be affected by this settlement

M

String

  • ticketSignature

Signature from MTS's response to initial ticket placement

M

String

  • bettId

Present only if "type": "bet", ID of the original bet that is to be affected by this settlement

M only if "type": "bet"

String

  • payout

Settlement payout array, minimal number of payouts per settlement =1, maximum number = 5

M

Array

    • type

Enumerator:

  • cash

  • withheld

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.htmlarrow-up-right

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

    • traceId

A string to help identify the source of operation/action/state

Minimal string length = 1, maximum length = 128,

O

String

Last updated

Was this helpful?