Payment Requests

Source
Destination

Client

→

MTS

Payment requests include the following specific requests:

  • Balance change request - provides information about any changes to the end customer's wallet balance

  • Deposit request - provides information about a deposit to a wallet (increase of the end customer's wallet balance)

  • Withdrawal request - provides information about a withdrawal from a wallet (decrease of the end customer's wallet balance)

This data helps MTS maintain a profile of the end customer, which in turn enables MTS's clients to conduct automated marketing campaigns, analyse their services, manage end customer churn and more.

Envelope and Content table:

The Envelope provides the content's 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 the corresponding 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 operation type, should be "balance-change-inform" in the case of a Balance change request or

"balance-deposit-inform" in the case of a Deposit request or

"balance-withdrawal-inform" in the case of a Withdrawal request

M

String

version

Indicates the ticket format version

M

String

}

Content object (Payment requests)

This object constitutes the request itself and contains the following fields:

  • type

  • balanceChangeId (or depositId or withdrawalId)

  • walletId

  • endCustomer

  • status

  • gateway

  • amount

  • initiatedAtUtc

  • executedAtUtc

  • source

Content object table:

Example
Field Name
Field Description
Mandatory/ Optional
Data Type

Object

type

Declaration of content type, should be "balance-change-inform" in the case of a Balance change request

or

"deposit-inform" in the case of a Deposit request or

"withdrawal-inform" in the case of a Withdrawal request

M

String

balanceChangeId

or depositId

or withdrawalId

Client defined string to identify the transaction type:

"balanceChangeId" in the case of a Balance change request or

"depositId" in the case of a Deposit inform request or

"withdrawalId" in the case of a Withdrawal inform request,

minimal string length = 1, maximum length = 36, allowed characters : uppercase and lowercase letters, numerals, :, -, _, \ Java regex: ^[0-9A-Za-z:\\-_]{1,36}$

M

String

walletId

Client defined string to identify the wallet (ID or type), minimal string length = 1, maximum string length = 128

O

String

endCustomer

Data about client's end customer (bettor)

M

Object

  • id

End customer's unique ID (in client's system). It should be an anonymous value which cannot be used to identify a physical person. minimal string length = 1, maximum length = 36, allowed characters are : uppercase and lowercase letters, numerals, #, :, -, _, \ Java regex: ^[0-9A-Za-z#:\\-_]{1,36}$

M

String

  • confidence

End customer's suggested CCF, Java regex: ^\\d{1,8}(\\.\\d{1,8})?$

O

String

status

Enum:

  • approved

  • rejected

  • pending

  • cancelled

M

String

gateway

Not included if "type": "balance-change-inform"

O

Object

  • provider

Client specific gateway provider identifier,

Minimal string length = 1, maximum length = 36, allowed characters : uppercase and lowercase letters, numerals, :, -, _, \ Java regex: ^[0-9A-Za-z:\\-_]{1,36}$

M

String

  • referenceId

Client specific gateway reference ID,

Minimal string length = 1, maximum length = 36, allowed characters : uppercase and lowercase letters, numerals, :, -, _, \ Java regex: ^[0-9A-Za-z:\\-_]{1,36}$

M

String

  • method

Enum:

  • credit-card

M

String

  • initiatedAtUtc

(Unix time in milliseconds format), minimal: 1, maximum: 9223372036854776000

O

Integer

  • executedAtUtc

(Unix time in milliseconds format), minimal: 1, maximum: 9223372036854776000

M

Integer

amount

Payment amount

M

Object

  • value

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

initiatedAtUtc

Not included if "type": "balance-change-inform",

Unix time in milliseconds format, minimal: 1, maximum: 9223372036854776000

O

Integer

executedAtUtc

Unix time in milliseconds format, minimal: 1, maximum: 9223372036854776000

M

Integer

source

Only included if "type": "balance-change-inform"

M

only if "type": "balance-change-inform"

Object

  • type

Enum:

  • ticket

  • deposit

  • withdrawal

M

String

  • id

Client defined source ID, minimal string length = 1, maximum string length = 128

M

String

  • action

Only included if "type": "ticket",

Enum:

  • place

  • payout

M

only if "type": "ticket"

String

Last updated

Was this helpful?