External Settlement Response

Destination
Source

Client

MTS

Envelope and Content table:

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

  • correlationId

  • timestampUtc

  • operation

  • version

Example
Field Name
Field Description
Mandatory/ Optional
Data Type

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 response

M

String

version

Indicates the ticket format version

M

String

}

Content object (External settlement response)

The Content object includes the following fields:

  • type

  • settlementId

  • signature

  • status

  • ticketId

  • code

  • message

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" instead of "type": "ext-settlement-reply. For description, see Error-reply Response.

Content object table:

Example
Field Name
Field Description
Mandatory/ Optional
Data Type

Object

type

Declaration of the content type, should be "ext-settlement-reply" in the case of External settlement response

or "error-reply" in the case of major ticket errors or internal system errors (see also Error-reply Response).

M

String

settlementId

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

ticketId

ID of the initial ticket (defined by client) which is to be affected with this cash-out

M

String

code

External settlement 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

}

External settlement response codes

Code
Description

Transaction processed

Client (bookmaker) not found

External content disabled

Ticket not found

Ticket rejected

Ticket version lower than 3.0

External settlement too high

External settlement sent for ticket including only Sportradar content

External settlement sent for ticket with unknown result

External settlement sent for ticket with losing Sportradar content selection(s)

Last updated

Was this helpful?