Error-reply Response

Destination
Source

Client

MTS

In several specific cases, instead of a normal response (with content object types: ticket-reply, cancel-reply, cashout-reply, ext-settlement-reply, ticket-ack-reply, cancel-ack-reply, cashout-ack-reply, ext-settlement-ack-reply) MTS returns a response with content object type = error-reply. This happens when a request is rejected by the Date Plane Router (some possible errors include authorisation error, configuration error, or missing content) or an internal Data Plane error has occurred.

Ticket structure

Like any other ticket, a response including an error-reply consists of an envelope and content.

Envelope and Content table:

The Envelope provides the Content's (Ticket placement 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

M

Object

       ...........

       ...........

  },

  "correlationId": "Uw59kwUL",

correlationId

The same string as submitted by client in the Ticket placement request

M

String

  "timestampUtc": 1678202889000,

timestampUtc

Timestamp of response placement (Unix time in milliseconds format), minimal: 1, maximum: 9223372036854776000

M

Integer

  "operation": "ticket-placement",

operation

Should be "ticket-placement" in case of Ticket placement response,

In case of Cancellation, Cashout and Non-SR settlement requests / responses, enumerator:

  • "ticket-cancel"

  • "ticket-cashout"

  • "ticket-ext-settlement",

In case of Acknowledgement messages and Acknowledgement reply messages - enumerator:

  • "ticket-placement-ack"

  • "ticket-cancel-ack"

  • "ticket-cashout-ack"

  • "ticket-ext-settlement-ack"

M

String

  "version": "3.0"

version

Indicates the ticket format version

M

String

}

Content object (error-reply response)

The Content object includes the following fields:

  • type

  • code

  • message

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

Object

      "type": "error-reply",

type

M

String

      "code": 100,

code

Data plane specific response code, see list below

M

Integer

      "message": "Authorization error"

message

Data plane specific response description, see list below

M

String

  },

Data plane specific response codes:

Code

0

Transaction processed

100

Authorisation error

101

Associated identity not authorised for the requested transaction client identifier

200

Configuration error

201

Client/operator not configured

202

Client/operator configuration invalid

203

Client/operator not configured for requested operation

300

System limitation error

301

Transaction mapping failed(%s)

400

Precondition error

401

Client/operator input precondition failed(%s)

402

Downstream service precondition failed

900

Downstream service precondition failed

901

Internal system input precondition failed(%s)

902

Transaction target response contained an unsupported response code(%s)

Last updated

Was this helpful?