Settlement

Information on how Lottery Operators can send Settlement events.

REST API

⬆️ POST /v2/integration/lottery [Settlement]

RabbitMQ Connector

RabbitMQ Message Properties

key	value
type	LOTTERY_V2

Kafka Connector

Kafka Message Headers

key	value
type	LOTTERY_V2

Sample Request for a settlement update

Example Payload

{
  "ticket_id": "2019020103308257480",
  "lottery_id": "1",
  "lottery_name": "Mega Millions",  
  "lottery_type": "Lottery",
  "draw_id": "1",
  "draw_date": "2015-03-02T8:27:58.721607+06:00",
  "currency": "EUR",
  "exchange_rate": 1,
  "draw_numbers": [32,23,12,11,35,54],
  "draw_special_numbers": [32],
  "amount": 2400,
  "lines": [{
    "line_id": 1,
    "matched_numbers": [12,32,35,54],
    "is_winning_line": false,
    "meta": {}
  },
  {
    "line_id": 2,
    "matched_numbers": [32,23,12,11,35,54],
    "matched_special_numbers": [32],
    "is_winning_line": true,
    "meta": {}
  }],
  "origin": "sub.example.com",
  "timestamp": "2015-03-02T8:27:58.721607+06:00",
  "type": "Settlement",
  "user_id": "52530",
  "meta": {}
}

Data Types

{
  "ticket_id": "string",
  "lottery_id": "string",
  "lottery_name": "string",  
  "lottery_type": "string",
  "draw_id": "string",
  "draw_date": "string", //RFC3339 format
  "currency": "string", //ISO 4217 format
  "exchange_rate": float,
  "draw_numbers": [32,23,12,11,35,54],
  "draw_special_numbers": [32],
  "amount": float,
  "lines": [{
    "line_id": float,
    "matched_numbers": [12,32,35,54],
    "is_winning_line": boolean,
    "meta": {}
  },
  "origin": "string",
  "timestamp": "string", //RFC3339 format
  "type": "string", //RFC3339 format
  "user_id": "string",
  "meta": {}
}

Required properties are marked with *

Key	Example Value	Description
ticket_id *	"2019020103308257480"	The unique identifer of the lottery ticket
lottery_id *	"1"	The unique identifier of the lottery
lottery_name *	"Mega Millions"	The text friendly name of the lottery
lottery_type *	"Lottery", "Raffle"	The type of lottery
draw_id *	"1"	The unique identifier of the draw
draw_date *	"2015-03-02T8:27:58.721607+06:00"	The date and time of when the draw took place, in RFC3339 format.
currency *	"EUR"	Transactions currency in ISO 4217 format
exchange_rate *	1	The exchange rate at the timestamp
draw_numbers	[32,23,12,11,35,54]	The winning numbers of the draw
draw_special_numbers	[32]	Any winning special number
amount *	4.0	The amount of the lottery purchase
lines *		See table below
origin *	"origin"	The of the transaction
timestamp *	"2015-03-02T8:27:58.721607+06:00"	The date and time of the purchase event, in RFC3339 format.
type *	"Bet", "Settlement"	Indicates wether the event was a Bet (Purchase) or a Settlement
user_id *	"123"	The unique identifier of the user
meta		A placeholder for any custom data that may be sent

Lines object

Key	Example Values	Description
line_id *	2	The unique identifier of the line
matched_numbers *	[32,23,12,11,35,54]	The winning numbers of this transaction
matched_special_numbers	[32]	Any special winning number of this transaction
is_winning_line *	true	If the line had winning numbers
meta		A placeholder for any custom data