Below is the integration flow, briefly explaining the functionality of each endpoint.
Syndicate Catalog
The Syndicates Catalog endpoint is designed to list and provide details of “syndicate” products (bolões) with all the necessary information for display and sale in the system.
Syndicate Detail
The Syndicate Detail endpoint is designed to return all detailed information of a specific product, identified by the productId.
Syndicate Lines Detail
The Syndicate Lines Detail endpoint is designed to provide the exact number combinations included in the bets (lines) that are part of a specific product, identified by the syndicate-name (e.g., MS-AAA-001).
Single Lines Catalog
The Single Lines Catalog endpoint is designed to list individual bets (“single-line”), offering all available options for a given draw, including prices and rules for the number of selections allowed for each lottery.
Single Line Detail
The Single Line Detail endpoint is designed to return all detailed information about a specific draw in the individual bet (“single-line”) category, identified by the lottery-slug.
Lotteries Details
The Lotteries Details endpoint is designed to provide detailed information about scheduled or recent draws for different lottery types, such as Quina, Mega-Sena, etc.
Cart Simulation
The Cart Simulation endpoint is used before placing an order, allowing verification of whether the products are in stock and pass all necessary validations. If the response is 200 (Ok), the order is consistent for sending.
Order
Now we can effectively close the order on the SOL side using the Order. At this moment, it is important to note that it is necessary to send a correlation ID for each item in the products array and one for the order. These IDs will be used in our communication, so whenever a call is made to obtain data or when SOL calls a webhook, these IDs will be transmitted.
Customer Orders
The Customer Orders endpoint is used to register a user’s order, including their personal information and selected products. When the request is successful, a unique Order ID is generated to identify the order.
Payment Voucher
The Payment Voucherendpoint can be used as proof of order for partners, providing all relevant details that validate the purchase.
Cancel Order
The Cancel Order endpoint is designed to cancel a betting order identified by it's orderCorrelationId.
Tickets
The Tickets endpoint is designed to provide digitized receipts of the purchased betting tickets and can be called after the webhook is sent. Its invocation must include the correlationIds to retrieve the tickets.
Webhooks
At certain points in the SOL ecosystem, webhooks will be triggered to inform that something is available, such as:
- Ticket available
- SOL order cancellation
- SOL CutOff
- PATCH – Order Confirmation
- PATCH – Order Cancellation
- PATCH – Completed Draws
- POST – Redemption Confirmation
Bet Details
The Bet Details endpoint is designed to return all detailed information about a specific bet, identified by the orderId field. It provides complete data about the product, draw, status, and bet structure, allowing precise tracking of every detail in the order.
Bets by Draw
The Bets By Draw endpoint is designed to return all bets associated with a specific draw, providing information about both the draw and the linked bets. It is used to check results, monitor prizes, and identify bets related to a particular contest.
Draws Participation
The Draws Participationendpoint is designed to list all contests (draws) in which bets were placed. It presents general information about each draw and allows paginated navigation through the results. This endpoint is useful for checking participation history and tracking the status of multiple draws.
Bet Draw Result
The Bet Draw Result endpoint is designed to return detailed results of a specific draw, including the drawn numbers and prizes for the participating bets. It allows you to check the official result of a contest and verify which bets were awarded.