Payout Modifier Settlement Response

Destination
Source

Client

MTS

Transaction structure

The Payout modifier settlement response, like any other transaction, consists of the envelope and content.

It is a reply to a Payout modifier settlement request.

Envelope and Content table:

The Envelope provides the content's (Payout-modifier settlement response) context and contains the following fields (besides Content):

  • correlationId

  • timestampUtc

  • operation

  • version

Example
Field Name
Field Description
Mandatory/Optional
Data Type
{

  "content": {
       ........
       ........
       },

content

See Content object description below

Mandatory

Object

  "correlationId": "jwo29bsl10",

correlationId

Same string as submitted by the client in the Payout modifier settlement request

Mandatory

String

  "timestampUtc": 1758193724000,

timestampUtc

Timestamp of the response placement (Unix time in 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 response

Mandatory

String

  "version": "3.0"
}

version

Indicates the ticket format version

Mandatory

String

Content object (Payout modifier settlement response)

The Content object includes the following fields:

  • type

  • signature

  • status

  • ticketId

  • code

  • message

  • betDetails

  • exchangeRate

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":"ticket-reply. For description, see Error-reply Response.

Content object table

Example
Field Name
Field Description
Mandatory/ Optional
Data Type
  "content": {

Object

      "type": "payout-modifier-
settlement-reply",

type

Declaration of content type, should be "payout-modifier-settlement-reply" in the case of a Payout modifier settlement response

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

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

      "signature": "vwswgzwiPn8hEjyPlzDY
u0B7aNA85fOeAB8moddwq82e",

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": "accepted",

status

Suggestion on ticket acceptance, provided by MTS, enumerator:

  • accepted

  • rejected

M

String

      "reference": "EZ0wq6jxM6WXT
vKtkbUFCzooiGcTqABm",

reference

Specifies the unique identifier of the promotion that has been used to identify outcomes that needed to be settled, client defined string, max. string length = 512, min. string length =1.

M

String

      "code": 0,

code

Ticket response validation code (the main reason the ticket has eventually been rejected), see list of validation codes

M

Integer

      "message": "Transaction processed"
 },

message

Readable ticket response validation code, minimal string length = 1, maximum string length = 128

M

String

Last updated

Was this helpful?