{"info":{"_postman_id":"d0a8a309-2893-fbd7-6504-80db40805e07","name":"Colossusbets Proplayer API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"1255977","collectionId":"d0a8a309-2893-fbd7-6504-80db40805e07","publishedId":"RVnWiK2Y","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-03-15T17:39:36.000Z"},"item":[{"name":"1. Introduction","item":[],"id":"b7a59232-2f6d-468c-84d5-06cf3fabff4d","description":"

About us

Colossus Bets offers the largest sports and racing jackpots in the world, and is the home of Partial Cash Out and Syndicates. For more information about the Colossus product, see our Corporate Website, our our Own Product build on this documentation.

This is a server-to-server API, providing a full interface into the multi-sport Colossus Bets engine, using HTTPS requests with JSON objects.

Units

These are the core measurement of the underlying system in order to keep the system currency-agnostic. Units need to be converted into a relevant user currency before being shown to customers. In this API you'll find exact instructions on how to deal with these values when encoutered. The units can have different value per pool.

Fx Rates

Fx rates can be provided from the API in order to transform the units into a given currency. (unit value * fx_rate for currency XYZ = XYZ value.\nWe are keeping the rates up to date, and they are static per pool, being set at the pool creation time, based on the pool base currency, and the unit.

Wallet Api Token Auth

Token Header Format

The authentication information should be included by the client in the headers of each authenticated request and it will be received in the same manner or as parameters in some cases. The headers follow the RFC 6750 Bearer Token format:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header Name	Value	Description
param	somesecuretoken	This serves as the user's password for each request. A hashed version of this value is stored in the database for later comparison. This value should be changed on each request.
token-type	Bearer	Token type
client	testclient	This enables the use of multiple simultaneous sessions on different clients. (For example, a user may want to be authenticated on both their phone and their laptop at the same time.)
expiry	tttttttt	The date at which the current session will expire. This can be used by clients to invalidate expired tokens without the need for an API request.
uid	zzzzz@yyy.com	A unique value that is used to identify the user. This is necessary because searching the DB for users by their access token will make the API susceptible to timing attacks.

The authentication headers required for each request will be available in the response from the previous request. You can have a look at ng-token-auth AngularJS module or the jToker jQuery plugin where this functionality is already provided.

\n","event":[{"listen":"prerequest","script":{"id":"c92eec20-d566-4205-a846-ad8199681767","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f0e11c18-78ec-4846-acd5-66efc0902301","type":"text/javascript","exec":[""]}}],"_postman_id":"b7a59232-2f6d-468c-84d5-06cf3fabff4d"},{"name":"2. Wallet Auth","item":[{"name":"users/sign_in","event":[{"listen":"prerequest","script":{"id":"dd0438fd-eadb-4f2b-96ac-ba38fb87d285","exec":["var TokenAuth = eval(globals.loadTokenAuth);","TokenAuth.setTime();",""],"type":"text/javascript"}},{"listen":"test","script":{"id":"739516d1-86c5-4f46-bd8c-b0805cc2e277","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var TokenAuth = eval(globals.loadTokenAuth);","TokenAuth.setHeadersIfSuccess();"],"type":"text/javascript"}}],"id":"2321d8b8-25f4-6af4-2eca-a3e313e58f22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"login\": \"{{username}}\",\n \"password\": \"{{password}}\"\n}"},"url":"{{wallet_api_url}}/users/sign_in","description":"

sign_in - POST `/users/sign_in`

logs in the user and returns the authentication headers, the customer state and whatever parameters required for login logic (sign_in_count?, notifications?)
it first checks if the user with the introduced email/username is authorized to log in
if the introduced password is wrong and the email address belongs to an account, it will be locked after a number of attempts, only if authorization passes
login field representing the email or the username
password
upon successful login information like failed_attempts, sign_in_count, last_sign_in_ip are being saved/reset

Error response examples

403\n{\n  \"status\": \"ERROR\",\n  \"error\": \"LOCKED\"\n}\n

the 403 error codes can be found in code en.yml under accounts tab and logic/translations can be build on them

401\n{\n  \"status\": \"ERROR\",\n  \"error\": \"BAD_CREDENTIALS\"\n}\n

Successfull response examples

200 { \"status\": \"SUCCESS\", \"data\": { state: 'active' }, \"message\": \"OK\" } + auth headers

\n","urlObject":{"path":["users","sign_in"],"host":["{{wallet_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"2321d8b8-25f4-6af4-2eca-a3e313e58f22"}],"id":"0ea8de21-00ea-56cf-4fc7-dcc65a40d395","event":[{"listen":"prerequest","script":{"id":"0bd2d2fa-5f16-41e1-a223-0c75817e193d","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e9b40b0-6d30-465a-8376-ae0e9f819fd9","type":"text/javascript","exec":[""]}}],"_postman_id":"0ea8de21-00ea-56cf-4fc7-dcc65a40d395","description":""},{"name":"3. Pools","item":[{"name":"Pool","event":[{"listen":"prerequest","script":{"id":"4f70d659-6a10-4e9d-838f-24a954137e23","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b91fa176-2d7b-4ed2-8489-f9fff5158136","type":"text/javascript","exec":["data = JSON.parse(responseBody);","var ToteTests = eval(globals.loadToteTests);","","ToteTests.checkPoolSerializer(data);"]}}],"id":"6126b500-ef3c-3936-03b1-d4bbbcbcb5f0","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":""},"url":"{{microsite_api_url}}/pools/{{pool_id}}?no_serializer=true¤cy=GBP","description":"

Retrieves a pool with a specific id.

Parameters:

pool_id required
no_serializer required with TRUE value, BOOLEAN, default: false
- no_serializer=true returns a faster response
- no_serializer=false is DEPRECATED
\n
currency optional (recommended), STRING, 3 letter ISO 4217, returns stake_sizes and fx_rates for the requested currency only
includes optional (recommended - empty), STRING, default: includes=prizes,fx_rates,smart_pick_perms,history.sport_event_history,legs.sport_event.competitors,sport_event.sport_event_competitors,legs.sport_event.venue,legs.sport_event.history,legs.sport_event.sport_code_sub_code,legs.sport_event.selections.unit_distributions, comma separated list of VALUE(.NESTED_VALUE)*, used for speeding up the request if not all pool information is needed
- includes= left empty will return pool without the nested elements
\n

Response example

\n{\n    \"id\": 29475,\n    \"name\": \"Race Winner Pick 7\",\n    \"type_code\": \"RACE_WIN\",\n    \"status\": \"ABANDONED\",\n    \"settlement_status\": \"NOT_READY\",\n    \"sched_start\": \"2018-03-01T15:00:00.000Z\",\n    \"sched_next\": \"2018-03-01T15:30:00.000Z\",\n    \"num_units\": \"14.61268774\",\n    \"headline_prize\": \"25000.0\",\n    \"in_rollback_mode\": false,\n    \"stake_sizes\": [\n        {\n            \"currency\": \"GBP\",\n            \"country\": \"00\",\n            \"stakes\": [\n                \"2.0\",\n                \"1.0\",\n                \"0.5\",\n                \"0.2\"\n            ],\n            \"min_stake\": \"0.01\",\n            \"max_stake\": \"2.1\",\n            \"min_cost\": \"0.01\",\n            \"max_cost\": \"100000000.0\"\n        }\n    ],\n    \"sport_code\": \"HORSE_RACING\",\n    \"leg_num\": 7,\n    \"sport_sub_code\": \"HORSERACING\",\n    \"show_sub_code\": false,\n    \"fx_rates\": [\n        {\n            \"currency\": \"GBP\",\n            \"rate\": \"2.0\"\n        }\n    ],\n    \"smart_pick_perms\": [],\n    \"free_play_only\": true,\n    \"available_syndicates\": 0,\n    \"has_offers\": false,\n    \"currency\": \"GBP\",\n    \"prizes\": [\n        {\n            \"prize_type_code\": \"WIN\",\n            \"amount\": \"25000.0\",\n            \"guarantee\": \"25000.0\",\n            \"carry_in\": \"0.0\",\n            \"pay_out\": \"0.0\",\n            \"win_units\": \"0.0\"\n        },\n        ...\n    ],\n    \"legs\": [\n        {\n            \"id\": 93381,\n            \"type_code\": \"RACE_WIN\",\n            \"official\": true,\n            \"display_order\": 1,\n            \"leg_order\": 1,\n            \"winning_selections\": [\n                {\n                    \"prize_code\": \"WIN\",\n                    \"selections\": [\n                        4,\n                        1,\n                        2,\n                        3,\n                        0\n                    ]\n                }\n            ],\n            \"sport_event\": {\n                \"id\": 83773,\n                \"name\": \"15:00 Cheltenham\",\n                \"status\": \"OFFICIAL\",\n                \"sport_code\": \"HORSE_RACING\",\n                \"sport_sub_code\": \"HORSERACING\",\n                \"sport_sub_code_desc\": null,\n                \"period\": null,\n                \"add_info_json\": {\n                    \"max_runners\": 4,\n                    \"advanced_going\": \"Heavy\",\n                    \"handicap\": false,\n                    \"track_type\": \"Hurdle\",\n                    \"race_type\": \"important\",\n                    \"eligibility\": \"yes\",\n                    \"distance\": \"2m3f\"\n                },\n                \"sched_start\": \"2018-03-01T15:00:00.000Z\",\n                \"competitors\": [\n                    {\n                        \"id\": 2347,\n                        \"name\": \"Ds Ben\",\n                        \"sport_code\": \"HORSE_RACING\",\n                        \"sport_sub_code\": \"HORSERACING\",\n                        \"colour\": \"B00707\",\n                        \"add_info_json\": null\n                    },\n                    ...\n                ],\n                \"sport_event_competitors\": [\n                    {\n                        \"id\": 171193,\n                        \"sport_event_id\": 83773,\n                        \"competitor_id\": 2347,\n                        \"cloth_number\": 4,\n                        \"name\": \"Allfredandnobell\",\n                        \"status\": null,\n                        \"withdrawn\": false,\n                        \"result\": null,\n                        \"favourite\": false,\n                        \"probability\": null,\n                        \"fractional_probability\": null,\n                        \"add_info_json\": {\n                            \"form_figure_type\": \"\",\n                            \"form_figure_text\": \"1538-36\",\n                            \"age\": 5,\n                            \"weight\": \"11-10\",\n                            \"trainer_id\": \"\",\n                            \"trainer_name\": \"Micky Hammond\",\n                            \"jockey_id\": \"\",\n                            \"jockey_name\": \"Finian O'Toole\",\n                            \"jockey_color_desc\": \"\",\n                            \"jockey_color_url\": \"\",\n                            \"allowance\": \"\"\n                        }\n                    },\n                    ...\n                ],\n                \"history\": [],\n                \"venue\": {\n                    \"code\": \"che\",\n                    \"name\": \"Cheltenham\",\n                    \"country\": \"England\"\n                }\n            },\n            \"selections\": [\n                {\n                    \"id\": 1356835,\n                    \"competitor_id\": 2347,\n                    \"sport_event_competitor_id\": 171193,\n                    \"bin\": 4,\n                    \"name\": \"Allfredandnobell\",\n                    \"price\": \"4.0\",\n                    \"display_order\": 4,\n                    \"add_info_json\": null,\n                    \"unit_distributions\": [\n                        {\n                            \"units\": \"0.0\",\n                            \"prize_code\": \"WIN\"\n                        }\n                    ]\n                },\n                ...\n            ]\n        },\n        ...\n    ],\n    \"history\": []\n}\n\n

\n","urlObject":{"path":["pools","{{pool_id}}"],"host":["{{microsite_api_url}}"],"query":[{"key":"no_serializer","value":"true"},{"key":"currency","value":"GBP"}],"variable":[]}},"response":[],"_postman_id":"6126b500-ef3c-3936-03b1-d4bbbcbcb5f0"},{"name":"Pools","event":[{"listen":"prerequest","script":{"id":"1fadb1a7-e33b-43a9-9eb8-938a5806e59b","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"00f0f38d-529d-4087-83f4-c606bcca44db","type":"text/javascript","exec":[""]}}],"id":"6def1ff9-8d7a-b560-68ec-1321e384a9d4","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"type_code\": \"RACE_WIN\",\n\"sport_code\": \"HORSE_RACING\",\n\"pool_id\": \"123456\",\n\"amount\": \"1\",\n\"currency\": \"CAD\",\n\"legs\": [\n {\n \"selections\": \"1/2/3/4/5/6/7/8/9/10\",\n \"scheduled_start\": \"2016-10-08T11:06:12.000Z\",\n \"leg_number\": 1\n },\n {\n \"selections\": \"1/2/3/4/5/6/7\",\n \"scheduled_start\": \"2016-10-08T11:40:12.000Z\",\n \"leg_number\": 2\n },\n {\n \"selections\": \"1/2/3/4/5/6/7\",\n \"scheduled_start\": \"2016-10-08T12:10:12.000Z\",\n \"leg_number\": 3\n },\n {\n \"selections\": \"1/2/3/4/5/6/7/8/9/10\",\n \"scheduled_start\": \"2016-10-08T18:12:12.000Z\",\n \"leg_number\": 4\n }],\n\"info\":\n{\n \"track_name\": \"Woodbine (SB)\",\n \"race_number\": \"13\"\n},\n\"prizes\": [\n { \n \"amount\": \"14000\",\n \"prize_code\":\"WIN\"\n }]\n}\n\n"},"url":"{{microsite_api_url}}/pools?ungrouped=true¤cy=GBP&no_serializer=true","description":"

Retrieves the list of pools available at the moment.

Parameters:

no_serializer required with TRUE value, BOOLEAN, default: false
- no_serializer=true returns a faster response
- no_serializer=false is DEPRECATED
\n
currency optional (recommended), STRING, 3 letter ISO 4217, returns stake_sizes and fx_rates for the requested currency only
includes optional (recommended - empty), STRING, default: includes=legs.sport_event, comma separated list of VALUE(.NESTED_VALUE)*, used for speeding up the request if not all pool information is needed
- includes= left empty will return pool without the nested elements
- we reccommend you to include only the information you must save/display for maximizing the preformance
- includes possible values when ungrouped=true&details=false: includes=legs.sport_event
- includes possible values when ungrouped=true&details=true: includes=prizes,fx_rates,smart_pick_perms,legs.sport_event.competitors,legs.sport_event.sport_event_competitors,legs.sport_event.venue,legs.selections, comma separated list of VALUE(.NESTED_VALUE) - note that requesting the full list should not be done often, might take some time to respond, and might return a JSON object that contains a few MB of data
\n
filters optional, HASH (key value pair), default: {}, flags for the pools
- sport_codes optional, array of STRING (see full list of SPORT_CODES at end of API document)
- type_codes optional, STRING, array of STRINGs (see full list of TYPE_CODES at end of API document)
- leg_nums optional, array of INT
- statuses optional, array of STRINGs
- ids optional, array of INT
- start_date optional
- end_date optional
\n
ungrouped optional, BOOLEAN, default: false
- support for ungrouped=false was REMOVED so ungrouped=true must be used
\n
details optional, BOOLEAN, default: false, returns PoolData structure (more complex) rather than PoolItemData structure

Response structure:

ungrouped=true - array of PoolItemData
ungrouped=true and details=true - array of PoolData

`PoolItemData` Response example

\n[\n    {\n        \"id\": 29475,\n        \"name\": \"Race Winner Pick 7\",\n        \"type_code\": \"RACE_WIN\",\n        \"headline_prize\": \"25000.0\",\n        \"status\": \"ABANDONED\",\n        \"sched_start\": \"2018-03-01T15:00:00.000Z\",\n        \"sched_next\": \"2018-03-01T15:30:00.000Z\",\n        \"stake_sizes\": [\n            {\n                \"currency\": \"GBP\",\n                \"country\": \"00\",\n                \"stakes\": [\n                    \"2.0\",\n                    \"1.0\",\n                    \"0.5\",\n                    \"0.2\"\n                ],\n                \"min_stake\": \"0.01\",\n                \"max_stake\": \"2.1\",\n                \"min_cost\": \"0.01\",\n                \"max_cost\": \"100000000.0\"\n            }\n        ],\n        \"leg_num\": 7,\n        \"sport_code\": \"HORSE_RACING\",\n        \"has_sport_event_in_progress\": true,\n        \"sport_sub_code\": \"HORSERACING\",\n        \"show_sub_code\": false,\n        \"fx_rates\": [\n            {\n                \"currency\": \"GBP\",\n                \"rate\": \"2.0\"\n            }\n        ],\n        \"free_play_only\": true,\n        \"available_syndicates\": 0,\n        \"has_offers\": false,\n        \"currency\": \"GBP\",\n        \"legs\": [\n            {\n                \"type_code\": \"RACE_WIN\",\n                \"display_order\": 1,\n                \"sport_event\": {\n                    \"sport_code\": \"HORSE_RACING\",\n                    \"sport_sub_code\": \"HORSERACING\",\n                    \"add_info_json\": {\n                        \"max_runners\": 4,\n                        \"advanced_going\": \"Heavy\",\n                        \"handicap\": false,\n                        \"track_type\": \"Hurdle\",\n                        \"race_type\": \"important\",\n                        \"eligibility\": \"yes\",\n                        \"distance\": \"2m3f\"\n                    },\n                    \"sched_start\": \"2018-03-01T15:00:00.000Z\",\n                    \"id\": 83773\n                }\n            },\n            ...\n        ]\n    },\n    ...\n]    \n

\n\n

Additional response info

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Field name	Note
type_code	See Pool Type Codes
headline_prize	This value is based on \"currency\"
status	See Pool Status Codes
sched_start	In pool, Kick-off time of the first match in the pool. In sport_event, Kick-off time of that particular match
sched_next	Kick-off time of the next match in the pool (null if all matches started)
sport_code	See Sport codes
display_order	Number indicating in which order the legs should be displayed
add_info_json	Dynamic set of data changing based on the (sport code, sport sub code) pair

","urlObject":{"path":["pools"],"host":["{{microsite_api_url}}"],"query":[{"key":"ungrouped","value":"true"},{"key":"currency","value":"GBP"},{"key":"no_serializer","value":"true"}],"variable":[]}},"response":[],"_postman_id":"6def1ff9-8d7a-b560-68ec-1321e384a9d4"}],"id":"b886ff43-d3c9-a879-5eee-3a892f5b5d26","event":[{"listen":"prerequest","script":{"id":"d7ab929b-b389-4844-80c5-7a621a9de4d3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"401e8453-b3d7-41c1-99da-2b4e9ee35341","type":"text/javascript","exec":[""]}}],"_postman_id":"b886ff43-d3c9-a879-5eee-3a892f5b5d26","description":""},{"name":"4. Tickets","item":[{"name":"Ticket [Auth]","event":[{"listen":"prerequest","script":{"id":"281caa10-f6a3-42a5-a349-bffd48729c27","type":"text/javascript","exec":["var CB = eval(globals.loadTokenAuth);","//CB.computeSignature(['customer_id']);"]}},{"listen":"test","script":{"id":"5ef73039-df60-40fe-aa3f-8ea4784a8a6b","type":"text/javascript","exec":["data = JSON.parse(responseBody);","var CB = eval(globals.loadColossus);","","//CB.checkTicketsItemSerializer(data.items[0]);"]}}],"id":"e5a931a9-9ff3-dfa5-c84e-b04ab22a6261","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"uid","value":"{{uid}}"},{"key":"access-token","value":"{{access-token}}"},{"key":"client","value":"{{client}}"}],"body":{"mode":"raw","raw":"{\n\"type_code\": \"RACE_WIN\",\n\"sport_code\": \"HORSE_RACING\",\n\"pool_id\": \"123456\",\n\"amount\": \"1\",\n\"currency\": \"CAD\",\n\"legs\": [\n {\n \"selections\": \"1/2/3/4/5/6/7/8/9/10\",\n \"scheduled_start\": \"2016-10-08T11:06:12.000Z\",\n \"leg_number\": 1\n },\n {\n \"selections\": \"1/2/3/4/5/6/7\",\n \"scheduled_start\": \"2016-10-08T11:40:12.000Z\",\n \"leg_number\": 2\n },\n {\n \"selections\": \"1/2/3/4/5/6/7\",\n \"scheduled_start\": \"2016-10-08T12:10:12.000Z\",\n \"leg_number\": 3\n },\n {\n \"selections\": \"1/2/3/4/5/6/7/8/9/10\",\n \"scheduled_start\": \"2016-10-08T18:12:12.000Z\",\n \"leg_number\": 4\n }],\n\"info\":\n{\n \"track_name\": \"Woodbine (SB)\",\n \"race_number\": \"13\"\n},\n\"prizes\": [\n { \n \"amount\": \"14000\",\n \"prize_code\":\"WIN\"\n }]\n}\n\n"},"url":"{{microsite_api_url}}/tickets/{{ticket_id}}?no_serializer=true","description":"

Returns a ticket

Parameters:

ticket_id required, INT
no_serializer required with TRUE value, BOOLEAN, default: false
no_serializer=true returns a faster response
no_serializer=false is DEPRECATED
includes optional, STRING, default: \"offer_transactions,syndicate.manager,pool_info,legs.sport_event,legs.selections\", comma separated list of VALUE(.NESTED_VALUE)*

Response example

\n\n{\n    \"id\": 100000099834,\n    \"customer_id\": \"nandobermejo\",\n    \"selections\": \"8/8/8\",\n    \"lines\": 1,\n    \"amount_owned_customer\": \"1.0\",\n    \"status\": \"PLACED\",\n    \"stake\": \"2.0\",\n    \"currency\": \"GBP\",\n    \"poc\": \"GB\",\n    \"smartpick\": 0,\n    \"created_at\": \"2018-01-17T15:18:49.000Z\",\n    \"is_live\": false,\n    \"is_live_win\": true,\n    \"is_live_consolation\": true,\n    \"merchant_ref\": \"1030-7314\",\n    \"is_free_play\": false,\n    \"fx_rate\": \"2.0\",\n    \"ow_settle_date\": \"2018-01-17\",\n    \"cross_sell\": 0,\n    \"customer_win_payout\": \"5000.0\",\n    \"customer_consolation_payout\": \"0.0\",\n    \"is_in_store\": false,\n    \"store_id\": null,\n    \"customer_payout\": \"5000.0\",\n    \"customer_winnings\": \"5000.0\",\n    \"pool_id\": 29374,\n    \"channel\": \"DESKTOP\",\n    \"syndicate_portion\": null,\n    \"stringified_id\": \"100000099834\",\n    \"cost\": \"2.0\",\n    \"units_per_line\": \"1.0\",\n    \"offers_accepted\": \"0.0\",\n    \"syndicate\": null,\n    \"live_offer\": null,\n    \"offer_transactions\": [],\n    \"is_security_code_changed\": null, \n    \"above_threshold\": null,\n    \"pool\": {\n        \"name\": \"Pick 3\",\n        \"type_code\": \"CORRECT_SCORE\",\n        \"status\": \"OFFICIAL\",\n        \"settlement_status\": \"READY\",\n        \"sched_start\": \"2018-06-06T11:00:00.000Z\",\n        \"sched_next\": null,\n        \"num_units\": \"1.0\",\n        \"headline_prize\": \"2500.0\",\n        \"in_rollback_mode\": false,\n        \"stake_sizes\": [\n            {\n                \"currency\": \"GBP\",\n                \"country\": \"00\",\n                \"stakes\": [\n                    \"2.0\",\n                    \"1.0\",\n                    \"0.5\",\n                    \"0.2\"\n                ],\n                \"min_stake\": \"0.01\",\n                \"max_stake\": \"2.1\",\n                \"min_cost\": \"0.01\",\n                \"max_cost\": \"100000000.0\"\n            }\n        ],\n        \"sport_code\": \"FOOTBALL\",\n        \"leg_num\": 3,\n        \"sport_sub_code\": \"ESFLIGA\",\n        \"show_sub_code\": true,\n        \"fx_rates\": [\n            {\n                \"currency\": \"GBP\",\n                \"rate\": \"2.0\"\n            }\n        ],\n        \"smart_pick_perms\": [\n            1,\n            2,\n            4,\n            8,\n            12,\n            18,\n            24,\n            36,\n            48,\n            60,\n            80,\n            100,\n            125,\n            216,\n            343,\n            512\n        ],\n        \"available_syndicates\": 0,\n        \"has_offers\": false,\n        \"currency\": \"GBP\",\n        \"prizes\": [\n            {\n                \"prize_type_code\": \"CON_N1\",\n                \"amount\": \"250.0\",\n                \"guarantee\": \"250.0\",\n                \"carry_in\": \"0.0\",\n                \"pay_out\": \"0.0\",\n                \"win_units\": \"0.0\"\n            },\n            {\n                \"prize_type_code\": \"WIN\",\n                \"amount\": \"2500.0\",\n                \"guarantee\": \"2500.0\",\n                \"carry_in\": \"0.0\",\n                \"pay_out\": \"2500.0\",\n                \"win_units\": \"1.0\"\n            }\n        ],\n        \"legs\": [\n            {\n                \"id\": 92669,\n                \"type_code\": \"CORRECT_SCORE\",\n                \"official\": true,\n                \"display_order\": 1,\n                \"leg_order\": 1,\n                \"winning_selections\": [\n                    {\n                        \"prize_code\": \"WIN\",\n                        \"selections\": [\n                            8\n                        ]\n                    }\n                ],\n                \"sport_event\": {\n                    \"id\": 83317,\n                    \"name\": \"Ath Bilbao v Atl Madrid\",\n                    \"status\": \"OFFICIAL\",\n                    \"sport_code\": \"FOOTBALL\",\n                    \"sport_sub_code\": \"ESFLIGA\",\n                    \"sport_sub_code_desc\": null,\n                    \"period\": \"FT\",\n                    \"add_info_json\": {\n                        \"home_id\": 503,\n                        \"home_name\": \"Ath Bilbao\",\n                        \"home_colour\": null,\n                        \"home_score\": 0,\n                        \"away_id\": 504,\n                        \"away_name\": \"Atl Madrid\",\n                        \"away_colour\": null,\n                        \"away_score\": 0,\n                        \"current_score\": \"0-0\",\n                        \"half_time_score\": \"0-0\",\n                        \"result_code\": \"Draw\",\n                        \"current_event_code\": null\n                    },\n                    \"sched_start\": \"2018-06-06T11:00:00.000Z\",\n                    \"competitors\": [\n                        {\n                            \"id\": 503,\n                            \"name\": \"Ath Bilbao\",\n                            \"sport_code\": \"FOOTBALL\",\n                            \"sport_sub_code\": \"ESFLIGA\",\n                            \"colour\": \"E7071B\",\n                            \"add_info_json\": null\n                        },\n                        {\n                            \"id\": 504,\n                            \"name\": \"Atl Madrid\",\n                            \"sport_code\": \"FOOTBALL\",\n                            \"sport_sub_code\": \"ESFLIGA\",\n                            \"colour\": \"C71910\",\n                            \"add_info_json\": null\n                        }\n                    ],\n                    \"history\": []\n                },\n                \"selections\": [\n                    {\n                        \"id\": 1349614,\n                        \"bin\": 1,\n                        \"name\": \"AOH\",\n                        \"price\": \"17.0\",\n                        \"display_order\": 1,\n                        \"add_info_json\": null,\n                        \"unit_distributions\": [\n                            {\n                                \"units\": \"0.0\",\n                                \"prize_code\": \"WIN\"\n                            }\n                        ]\n                    },\n                    ...\n                ]\n            },\n            ...\n        ],\n        \"history\": [\n            {\n                \"event_code\": \"STARTED\",\n                \"remaining_units\": \"1.0\",\n                \"prize_code\": \"WIN\",\n                \"sport_event_history\": {\n                    \"event_code\": \"STARTED\",\n                    \"event_time\": \"2018-01-17T15:19:33.000Z\",\n                    \"event_info_json\": {\n                        \"home_id\": 503,\n                        \"home_name\": \"Ath Bilbao\",\n                        \"home_colour\": null,\n                        \"home_score\": 0,\n                        \"away_id\": 504,\n                        \"away_name\": \"Atl Madrid\",\n                        \"away_colour\": null,\n                        \"away_score\": 0,\n                        \"current_score\": \"0-0\",\n                        \"half_time_score\": null,\n                        \"result_code\": \"Draw\",\n                        \"current_event_code\": null\n                    }\n                }\n            },\n            ...\n        ],\n        \"id\": 29374\n    }\n}    
\n

\n\n \n \n \n \n \n \n \n \n \n \n \n \n

Field name	Note
is_security_code_changed	Boolean flag only populated for retail tickets
pin	Pin of the retail ticket

\n ","urlObject":{"path":["tickets","{{ticket_id}}"],"host":["{{microsite_api_url}}"],"query":[{"key":"no_serializer","value":"true"}],"variable":[]}},"response":[],"_postman_id":"e5a931a9-9ff3-dfa5-c84e-b04ab22a6261"},{"name":"Tickets [Auth]","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var CB = eval(globals.loadTokenAuth);","//CB.computeSignature(['customer_id']);"]}},{"listen":"test","script":{"type":"text/javascript","exec":["data = JSON.parse(responseBody);","var CB = eval(globals.loadColossus);","","CB.checkTicketsItemSerializer(data.items[0]);"]}}],"id":"312553af-5c46-e1f7-d7ee-366fe8c0fdf0","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"uid","value":"{{uid}}"},{"key":"access-token","value":"{{access-token}}"},{"key":"client","value":"{{client}}"}],"body":{"mode":"raw","raw":"{\n\"type_code\": \"RACE_WIN\",\n\"sport_code\": \"HORSE_RACING\",\n\"pool_id\": \"123456\",\n\"amount\": \"1\",\n\"currency\": \"CAD\",\n\"legs\": [\n {\n \"selections\": \"1/2/3/4/5/6/7/8/9/10\",\n \"scheduled_start\": \"2016-10-08T11:06:12.000Z\",\n \"leg_number\": 1\n },\n {\n \"selections\": \"1/2/3/4/5/6/7\",\n \"scheduled_start\": \"2016-10-08T11:40:12.000Z\",\n \"leg_number\": 2\n },\n {\n \"selections\": \"1/2/3/4/5/6/7\",\n \"scheduled_start\": \"2016-10-08T12:10:12.000Z\",\n \"leg_number\": 3\n },\n {\n \"selections\": \"1/2/3/4/5/6/7/8/9/10\",\n \"scheduled_start\": \"2016-10-08T18:12:12.000Z\",\n \"leg_number\": 4\n }],\n\"info\":\n{\n \"track_name\": \"Woodbine (SB)\",\n \"race_number\": \"13\"\n},\n\"prizes\": [\n { \n \"amount\": \"14000\",\n \"prize_code\":\"WIN\"\n }]\n}\n\n"},"url":"{{microsite_api_url}}/tickets?no_serializer=true","description":"

Returns the tickets for a given customer

Parameters:

no_serializer required with TRUE value, BOOLEAN, default: false
- no_serializer=true returns a faster response
- no_serializer=false is DEPRECATED
\n
customer_id required, STRING, the customer's id
type optional, INT, in: [0, 1, 2], default: 0, 0 = all, 1 = live, 2 = historic(not live)
from_date optional, DATETIME
to_date optional, DATETIME
per optional, INT, number of tickets per page, for pagination purposes
page optional, INT, default: 0, page number, for pagination purposes
pool_id optional, INT
filters optional, HASH(key value pair), default: {}, flags for the tickets
- is_in_store optional, BOOLEAN, default: false
- is_free_play optional, BOOLEAN, default: false
- is_managed_syndicate optional, BOOLEAN, default: false
- is_joined_syndicate optional, BOOLEAN, default: false
- is_solo_bet optional, BOOLEAN, default: false
- with_offer optional, BOOLEAN, default: false
- pool_type optional, STRING (see full list of TYPE_CODES at end of API document)
- pool_types optional, STRING, default: '', comma separated list of SPORT_CODE.TYPE_CODE (see full list of SPORT_CODES at end of API document)
- leg_num optional, INT
- sport optional, STRING (see full list of SPORT_CODES at end of API document)
\n
sort_by optional, STRING, in: [total_winnings_customer_local, cost_local, created_at]
sort_asc optional, BOOLEAN, default: false
includes optional, STRING, default: \"pool,syndicate.manager\", comma separated list of VALUE(.NESTED_VALUE)*

Response example

\n{\n    \"items\": [\n        {\n            \"id\": 100000099834,\n            \"status\": \"PLACED\",\n            \"currency\": \"GBP\",\n            \"lines\": 1,\n            \"amount_owned_customer\": \"1.0\",\n            \"created_at\": \"2018-01-17T15:18:49.000Z\",\n            \"offer_amount\": \"0.0\",\n            \"is_live_win\": true,\n            \"is_live_consolation\": true,\n            \"merchant_ref\": \"1030-7314\",\n            \"is_live\": false,\n            \"is_free_play\": false,\n            \"fx_rate\": \"2.0\",\n            \"is_in_store\": false,\n            \"store_id\": null,\n            \"customer_payout\": \"5000.0\",\n            \"customer_winnings\": \"5000.0\",\n            \"pool_id\": 29374,\n            \"channel\": \"DESKTOP\",\n            \"syndicate_portion\": null,\n            \"syndicate_id\": null,\n            \"stringified_id\": \"100000099834\",\n            \"stake\": \"2.0\",\n            \"cost\": \"2.0\",\n            \"offers_accepted\": \"0.0\",\n            \"syndicate\": null,\n            \"pool\": {\n                \"id\": 29374,\n                \"name\": \"Pick 3\",\n                \"type_code\": \"CORRECT_SCORE\",\n                \"headline_prize\": \"2500.0\",\n                \"status\": \"OFFICIAL\",\n                \"sched_start\": \"2018-06-06T11:00:00.000Z\",\n                \"sched_next\": null,\n                \"stake_sizes\": [\n                    {\n                        \"currency\": \"GBP\",\n                        \"country\": \"00\",\n                        \"stakes\": [\n                            \"2.0\",\n                            \"1.0\",\n                            \"0.5\",\n                            \"0.2\"\n                        ],\n                        \"min_stake\": \"0.01\",\n                        \"max_stake\": \"2.1\",\n                        \"min_cost\": \"0.01\",\n                        \"max_cost\": \"100000000.0\"\n                    }\n                ],\n                \"leg_num\": 3,\n                \"sport_code\": \"FOOTBALL\",\n                \"has_sport_event_in_progress\": false,\n                \"sport_sub_code\": \"ESFLIGA\",\n                \"show_sub_code\": true,\n                \"fx_rates\": [\n                    {\n                        \"currency\": \"GBP\",\n                        \"rate\": \"2.0\"\n                    }\n                ],\n                \"available_syndicates\": 0,\n                \"has_offers\": false,\n                \"currency\": \"GBP\"\n            }\n        },\n        ...\n    ],\n    \"total_items\": 581\n}\n

\n ","urlObject":{"path":["tickets"],"host":["{{microsite_api_url}}"],"query":[{"key":"no_serializer","value":"true"}],"variable":[]}},"response":[],"_postman_id":"312553af-5c46-e1f7-d7ee-366fe8c0fdf0"},{"name":"Ticket [Auth]","event":[{"listen":"prerequest","script":{"id":"b392f278-7d93-4163-acea-4d2ee880de50","type":"text/javascript","exec":["var CB = eval(globals.loadTokenAuth);"]}},{"listen":"test","script":{"id":"07bf9c79-23cb-4ace-89a5-8c9951bf1ea1","type":"text/javascript","exec":["data = JSON.parse(responseBody);","postman.setEnvironmentVariable('ticket_id', data.id)","","var CB = eval(globals.loadColossus);","CB.checkPlacedTicketSerializer(data);"]}}],"id":"a16c38d3-ba0d-c8f3-be52-0d287fa70ce3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"uid","value":"{{uid}}"},{"key":"access-token","value":"{{access-token}}"},{"key":"client","value":"{{client}}"}],"body":{"mode":"raw","raw":"{\n \"ticket\": {\n \"merchant_ref\" : \"{{rand_ref}}\",\n \"customer_id\" : \"{{customer_id}}\",\n \"pool_id\": \"{{pool_id}}\",\n \"selections\": \"1/1/1/1\",\n \"stake\" : \"2.00\",\n \"cost\" : \"2.0\",\n \"currency\" : \"GBP\",\n \"poc\" : \"GB\"\n }\n}"},"url":"{{microsite_api_url}}/tickets","description":"

Places a ticket in the tote.

Parameters:

ticket required, HASH, having the following parameters:
- pool_id required, INT
- selections required, STRING, comma separated values of the bin parameter from the pool
- stake required, STRING
- cost required, STRING
- currency required, STRING, 3 letter ISO 4217
- channel optional, STRING, one of the values [DESKTOP MOBILE MOBILE_APP STORE STORE_BOOKABET SMS PRO SEMI_PRO]. Mainly used for reporting
- smartpick optional, INT, default: 0
  - 0 value - the smart pick wasn't used to generate the selections
  - 1 value - the smart pick was used to generate the selections
  - 2 value - the smart pick was used to generate the selections and some selections were changed by the user
  \n
- cross_sell optional, INT, default: 0
  - 0 value - the ticket is not a cross sell one
  - 1 value - the ticket is a cross sell one
  - 2 value - the ticket is a cross sell one but some selections were changed by the user
  \n
- free_play_id optional, STRING and represents the token id associated with a free to play campaign
\n

Response example

\n\n{\n    \"id\": \"100000099933\",\n    \"merchant_ref\": \"1030-7350\",\n    \"selections\": \"1/1/1/1/1/1\",\n    \"stake\": \"2.00\",\n    \"cost\": \"2.0\",\n    \"currency\": \"GBP\",\n    \"cross_sell_suggestion\": null,\n    \"security_code\": null,\n    \"syndicate\": null,\n    \"pin\": null\n}
\n

Additional response info

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n

Field name	Note
security_code	Is only populated with a value when the ticket is a retail one
pin	Is only populated with a value when the ticket is a retail one

","urlObject":{"path":["tickets"],"host":["{{microsite_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a16c38d3-ba0d-c8f3-be52-0d287fa70ce3"},{"name":"Tickets Batch [Auth]","event":[{"listen":"test","script":{"id":"2584e456-9ae4-4054-bb3b-2d3ce85671bd","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"2bf12b6b-920e-4503-b3ed-f2f12d72c130","exec":["var CB = eval(globals.loadTokenAuth);"],"type":"text/javascript"}}],"id":"d2f763f7-fec1-493d-a3a4-2bce1a03abcc","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"uid","value":"{{uid}}"},{"key":"access-token","value":"{{access-token}}"},{"key":"client","value":"{{client}}"}],"body":{"mode":"raw","raw":"{\n \"response_type\": \"old\",\n \"tickets\": [{\n\t\"pool_id\": \"{{pool_id}}\",\n \"selections\": \"1/1/1/1/1\",\n \"stake\": \"2.00\",\n \"cost\": \"2.0\",\n \"currency\": \"GBP\",\n \"backref\": \"abcd\"\n },\n {\n\t\"pool_id\": \"{{pool_id}}\",\n \"selections\": \"1/1/1/1/2\",\n \"stake\": \"2.00\",\n \"cost\": \"2.0\",\n \"currency\": \"GBP\",\n \"backref\": \"abcd\"\n }]\n}"},"url":"{{microsite_api_url}}/tickets/batch","description":"

Places a batch of tickets in the tote.\nRecommendeed batch size between 200-500.

Parameters:

response_type optional, recommended, changes to a faster implementation, changes the response type to a more detailed report
- in order to use the new value, please inform us your username/customer_id first !
\n
ticket required, ARRAY, having the following parameters:
- pool_id required, INT
- selections required, STRING, comma separated values of the bin parameter from the pool
- stake required, STRING
- cost required, STRING
- currency required, STRING, 3 letter ISO 4217
- backref, required, STRING, used for identifying a ticket in a batch
- channel optional, STRING, default: 'DESKTOP', in: [DESKTOP MOBILE MOBILE_APP STORE STORE_BOOKABET SMS PRO SEMI_PRO]. Mainly used for reporting, please populate with 'PRO' if you consider yourself to be one.
\n

Response example:

{\n    \"backref1\": {\n        \"id\": 100000171793,\n        \"merchant_ref\": \"1037-8628\",\n        \"selections\": \"1/1/1/1\",\n        \"stake\": \"2.00\",\n        \"cost\": \"2.0\",\n        \"currency\": \"GBP\"\n    },\n    \"backref2\": {\n        \"id\": 100000171794,\n        \"merchant_ref\": \"1037-8629\",\n        \"selections\": \"1/1/1/2\",\n        \"stake\": \"2.00\",\n        \"cost\": \"2.0\",\n        \"currency\": \"GBP\"\n    }\n}\n

NEW response example:

{\n    \"batch_ref\": \"postman-ref-972646987092\", # we generate a batch reference for the entire ticket set sent, the wallet transaction reference\n    \"placed\": [ # standard TOTE ticket placement response, note that the data under `placed` is different than the data under `rejected`\n        {\n            \"id\": 500000367612, # our tote ticket id, to use for further requesting the ticket information\n            \"merchant_settlement_currency\": \"GBP\",\n            \"merchant_settlement_cost\": 2, \n            \"takeout_gbp\": 0.6,\n            \"customer_currency\": \"GBP\",\n            \"customer_cost\": 2,\n            \"takeout\": 0.6, # cost - takeout = the amount placed in the pool out or your bet :)\n            \"status\": \"PENDING\", # ticket has status pending until accepted on tote (can take up to around 5 seconds depending on load)\n            \"created_at\": 1558535188856, # epoch time stamp at creation\n            \"merchant_ref\": \"postman-ref-972646987092\", # individual tote bet reference, needed internaly as parent transaction for potential win/loss/void/cashout actions\n            \"backref\": \"postman-ref-972646987092\" # the backref that you sent in the request \n        }\n    ],\n    \"rejected\": [  # note that the data under `placed` is different than the data under `rejected`\n        {\n            \"params\": { # the parameters that were sent to the tote 'AS IS' for this ticket, so you can debug easily\n                \"pool_id\": 323,\n                \"selections\": \"1/1/1\",\n                \"stake\": \"2.00\",\n                \"cost\": \"2.00\",\n                \"currency\": \"GBP\",\n                \"channel\": \"DESKTOP\",\n                \"smartpick\": 0, \n                \"cross_sell\": 0,\n                \"poc\": \"GB\", # your wallet country code\n                \"customer_id\": \"silvius\", # your wallet customer_id\n                \"merchant_ref\": \"postman-ref-972646987092\",\n                \"backref\": \"postman-ref-972646987092\"\n            },\n            \"reason\": \"Pool 323 not in cache\" # rejection reson\n        }\n    ]\n}\n

","urlObject":{"path":["tickets","batch"],"host":["{{microsite_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d2f763f7-fec1-493d-a3a4-2bce1a03abcc"},{"name":"Tickets Batch - NEW endpoint [Auth]","event":[{"listen":"test","script":{"id":"2584e456-9ae4-4054-bb3b-2d3ce85671bd","exec":[""],"type":"text/javascript"}},{"listen":"prerequest","script":{"id":"2bf12b6b-920e-4503-b3ed-f2f12d72c130","exec":["var CB = eval(globals.loadTokenAuth);"],"type":"text/javascript"}}],"id":"dff1f4ab-8b79-47f6-8bd6-247c37395a69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"uid","value":"{{uid}}"},{"key":"access-token","value":"{{access-token}}"},{"key":"client","value":"{{client}}"}],"body":{"mode":"raw","raw":"{\n \"response_type\": \"old\",\n \"tickets\": [{\n\t\"pool_id\": \"{{pool_id}}\",\n \"selections\": \"1/1/1/1/1\",\n \"stake\": \"2.00\",\n \"cost\": \"2.0\",\n \"currency\": \"GBP\",\n \"backref\": \"abcd\"\n },\n {\n\t\"pool_id\": \"{{pool_id}}\",\n \"selections\": \"1/1/1/1/2\",\n \"stake\": \"2.00\",\n \"cost\": \"2.0\",\n \"currency\": \"GBP\",\n \"backref\": \"abcd\"\n }]\n}"},"url":"{{microsite_api_url}}/tickets/batch","description":"

Places a batch of tickets in the tote.\nRecommendeed batch size between 200-500.

Parameters:

response_type optional, recommended, changes to a faster implementation, changes the response type to a more detailed report
- in order to use the new value, please inform us your username/customer_id first !
\n
ticket required, ARRAY, having the following parameters:
- pool_id required, INT
- selections required, STRING, comma separated values of the bin parameter from the pool
- stake required, STRING
- cost required, STRING
- currency required, STRING, 3 letter ISO 4217
- backref, required, STRING, used for identifying a ticket in a batch
- channel optional, STRING, default: 'DESKTOP', in: [DESKTOP MOBILE MOBILE_APP STORE STORE_BOOKABET SMS PRO SEMI_PRO]. Mainly used for reporting, please populate with 'PRO' if you consider yourself to be one.
\n

Response example:

{\n    \"backref1\": {\n        \"id\": 100000171793,\n        \"merchant_ref\": \"1037-8628\",\n        \"selections\": \"1/1/1/1\",\n        \"stake\": \"2.00\",\n        \"cost\": \"2.0\",\n        \"currency\": \"GBP\"\n    },\n    \"backref2\": {\n        \"id\": 100000171794,\n        \"merchant_ref\": \"1037-8629\",\n        \"selections\": \"1/1/1/2\",\n        \"stake\": \"2.00\",\n        \"cost\": \"2.0\",\n        \"currency\": \"GBP\"\n    }\n}\n

NEW response example:

{\n    \"batch_ref\": \"postman-ref-972646987092\", # we generate a batch reference for the entire ticket set sent, the wallet transaction reference\n    \"placed\": [ # standard TOTE ticket placement response, note that the data under `placed` is different than the data under `rejected`\n        {\n            \"id\": 500000367612, # our tote ticket id, to use for further requesting the ticket information\n            \"merchant_settlement_currency\": \"GBP\",\n            \"merchant_settlement_cost\": 2, \n            \"takeout_gbp\": 0.6,\n            \"customer_currency\": \"GBP\",\n            \"customer_cost\": 2,\n            \"takeout\": 0.6, # cost - takeout = the amount placed in the pool out or your bet :)\n            \"status\": \"PENDING\", # ticket has status pending until accepted on tote (can take up to around 5 seconds depending on load)\n            \"created_at\": 1558535188856, # epoch time stamp at creation\n            \"merchant_ref\": \"postman-ref-972646987092\", # individual tote bet reference, needed internaly as parent transaction for potential win/loss/void/cashout actions\n            \"backref\": \"postman-ref-972646987092\" # the backref that you sent in the request \n        }\n    ],\n    \"rejected\": [  # note that the data under `placed` is different than the data under `rejected`\n        {\n            \"params\": { # the parameters that were sent to the tote 'AS IS' for this ticket, so you can debug easily\n                \"pool_id\": 323,\n                \"selections\": \"1/1/1\",\n                \"stake\": \"2.00\",\n                \"cost\": \"2.00\",\n                \"currency\": \"GBP\",\n                \"channel\": \"DESKTOP\",\n                \"smartpick\": 0, \n                \"cross_sell\": 0,\n                \"poc\": \"GB\", # your wallet country code\n                \"customer_id\": \"silvius\", # your wallet customer_id\n                \"merchant_ref\": \"postman-ref-972646987092\",\n                \"backref\": \"postman-ref-972646987092\"\n            },\n            \"reason\": \"Pool 323 not in cache\" # rejection reson\n        }\n    ]\n}\n

","urlObject":{"path":["tickets","batch"],"host":["{{microsite_api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dff1f4ab-8b79-47f6-8bd6-247c37395a69"}],"id":"53e99839-93a6-2114-cf46-a4a829281ed4","event":[{"listen":"prerequest","script":{"id":"dce1df1d-9fcc-4bd6-aa74-6766dc47f8d3","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"8e8190c6-aab5-4ed2-a4ca-b6524806885b","type":"text/javascript","exec":[""]}}],"_postman_id":"53e99839-93a6-2114-cf46-a4a829281ed4","description":""},{"name":"5. Cash Out Offers","item":[{"name":"Offers [Auth]","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var ApiAuth = eval(globals.loadApiAuth);","ApiAuth.computeSignature();"]}},{"listen":"test","script":{"type":"text/javascript","exec":["data = JSON.parse(responseBody);","var ToteTests = eval(globals.loadToteTests);","","ToteTests.checkOffersItemSerializer(data[0]);"]}}],"id":"146cfa2e-2faf-a9ee-707f-01f29c3904a4","request":{"method":"GET","header":[{"key":"Authorization","value":"{{api_auth_sha}} {{api_auth_key}}:{{signature}}"},{"key":"Date","value":"{{time}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Content-MD5","value":"{{content-MD5}}"}],"body":{"mode":"raw","raw":""},"url":"{{api_url}}/pools/{{pool_id}}/offers","description":"

Returns the list of all the offers for a specific pool.\nParameters:

pool_id required, INT, the id of the pool

Response example

\n\n[\n    {\n        \"customer_id\": \"20011212\",\n        \"offers\": 18,\n        \"max_offer\": \"56.05184868\"\n    }\n]
\n

\n","urlObject":{"path":["pools","{{pool_id}}","offers"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"146cfa2e-2faf-a9ee-707f-01f29c3904a4"},{"name":"Offer [Auth]","event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":["var CB = eval(globals.loadColossus);","CB.computeSignature(['offer_id']);",""]}},{"listen":"test","script":{"type":"text/javascript","exec":["data = JSON.parse(responseBody);","var CB = eval(globals.loadColossus);","","CB.checkOfferSerializer(data);"]}}],"id":"27887cce-6f3b-d9cf-a712-92aad6caf86c","request":{"method":"GET","header":[{"key":"Authorization","value":"{{api_auth_sha}} {{api_auth_key}}:{{signature}}"},{"key":"Date","value":"{{time}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Content-MD5","value":"{{content-MD5}}"}],"body":{"mode":"raw","raw":""},"url":"{{api_url}}/offers/{{offer_id}}","description":"

Returns all the details for an offer.\nParameters:

offer_id required, STRING, the id of the offer

Response example

\n\n{\n    \"id\": \"A27495-1-76239-1\",\n    \"customer_id\": \"paulacarasek2\",\n    \"ticket_id\": 220000000000197309,\n    \"amount\": \"155.709342015712\",\n    \"leg_num\": 1,\n    \"pool_id\": 27495,\n    \"transactions\": [\n        {\n            \"id\": 5795,\n            \"amount_sold_units\": \"0.69446133\",\n            \"merchant_margin_local\": \"1.73\",\n            \"total_margin_local\": \"1.73\",\n            \"created_at\": \"2017-04-04T10:20:03.000Z\",\n            \"merchant_offer_acceptance_ref\": \"1013-6868\",\n            \"amount_sold_fraction\": \"0.1\",\n            \"amount_sold\": \"15.57\"\n        },\n        ...\n    ]\n}
\n

\n","urlObject":{"path":["offers","{{offer_id}}"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"27887cce-6f3b-d9cf-a712-92aad6caf86c"},{"name":"Accept Offer [Auth]","event":[{"listen":"prerequest","script":{"id":"29c5be73-fa1c-4995-9f0a-751a58dc5bcc","exec":["var CB = eval(globals.loadColossus);","CB.computeSignature(['offer_id']);",""],"type":"text/javascript"}}],"id":"51523b1b-f884-4c2d-9446-d72f72a7ba86","request":{"method":"POST","header":[{"key":"Authorization","value":"{{api_auth_sha}} {{api_auth_key}}:{{signature}}"},{"key":"Date","value":"{{time}}"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Content-MD5","value":"{{content-MD5}}"}],"body":{"mode":"raw","raw":"{\n \"accept_fraction\": \"0.1\",\n \"remaining_fraction\": \"0.9\",\n \"accept_amount\": \"2205.24\"\n}"},"url":"{{api_url}}/offers/{{offer_id}}/accept","description":"

Accept an offer or a fraction of an offer.

Parameters:

accept_fraction required, STRING, the accepted fraction of the offer
remaining_fraction required, STRING, the remaining fraction of the offer, for validation purposes
accept_amount required, STRING, the accepted amount expressed in the user's currency, for validation purposes, must be truncated at two decimal places

For example:

if a customer cashes out 20% of their ticket, then accept_fraction='0.2', remaining_fraction='0.8'
if the same customer then cashes out a further 10% of their ticket, then accept_fraction='0.1', remaining_fraction='0.7'

\n","urlObject":{"path":["offers","{{offer_id}}","accept"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"51523b1b-f884-4c2d-9446-d72f72a7ba86"}],"id":"793ed252-e43b-3ce0-1c1a-b3239d6a2bc8","description":"

The endpoints in this section are used for managing Cash Out offers.

Key endpoints are:

GET Offers - returns all of the offers for a specific pool
GET Offer - returns a specific offer (however details of the offer are also included in the ticket detail, so this endpoint is not necessary and only included for reference)
POST Accept Offer - accept a Cash Out offer

\n","event":[{"listen":"prerequest","script":{"id":"a3c6ce6c-d8f9-4c79-9cf9-cc50f5a9cb2c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"2c0cfb69-7d03-4678-bcdd-4c6f82ea4b64","type":"text/javascript","exec":[""]}}],"_postman_id":"793ed252-e43b-3ce0-1c1a-b3239d6a2bc8"},{"name":"6. Data Type and Status Codes","item":[],"id":"2908415e-6648-7a3d-c1f5-a9b38bea7bf2","description":"

This section contains a list of codes used in the API.

Sport Codes

FOOTBALL
HORSE_RACING
GREYHOUNDS
TENNIS
NFL
NBA
AFL
RUGBY
ICE_HOCKEY
DARTS
WRC
MIXED
SPECIAL
ESPORTS
FANTASY_NFL
FANTASY_NBA

Type Codes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Sport Code	Type Code	Description
FOOTBALL	CORRECT_SCORE	Correct Score
FOOTBALL	HDA	1 x 2 (Home / Draw / Away)
FOOTBALL	ASIAN_HANDICAP	Winning team with handicap
FOOTBALL	BTTS	Both teams to score (yes or no)
FOOTBALL	OVER_UNDER	Over or under a certain number of goals (usually 2.5)
HORSE_RACING,GREYHOUNDS,WRC	RACE_WIN	Pick the winner of each leg (one or more legs)
HORSE_RACING,GREYHOUNDS,WRC	RACE_PLACE	Top n finishers(placers) in each leg (one or more legs)
HORSE_RACING,GREYHOUNDS,WRC	RACE_ORDER	Pick the runners order of finish (same event)
TENNIS	CORRECT_SCORE_5	Correct sets, for 5 set games
TENNIS	CORRECT_SCORE_3	Correct sets, for 3 set games
ESPORTS	H2H	Head to head - Pick the team that will win
ESPORTS	HA	Head / Away - Pick the team that will win
ESPORTS	OVER_UNDER	Over or under a certain number of points, depending on the game
ESPORTS	HDA	1 x 2 (Home / Draw / Away)
FANTASY_NFL,FANTASY_NBA	MVP	The player with the highest score (fantasy sports)
TENNIS	H2H	Head to head - Pick the tennis player that will last in the tournament the longest
AFL,NFL,NBA,RUGBY,ICE_HOCKEY	POINT_MARGIN	Pick the correct winning margin of points - used in high scoring games
DARTS	CORRECT_SCORE_9	Correct score in the best of 9 matches
DARTS	CORRECT_SCORE_12	Correct score in the best of 12 matches
DARTS	CORRECT_SCORE_14	Correct score in the best of 14 matches
FANTASY_ESPORTS	EVENT_WIN	Pick the winner of each leg (one or more legs)
FANTASY_ESPORTS	EVENT_ORDER	Pick the final position of each competitor (same event)

Pool Status Codes

OPEN (the pool is open for betting)
IN_PLAY (the pool is currently in progress, new bets are no longer accepted)
OFFICIAL (the pool has finished, all games within the pool have finished)
ABANDONED (the pool has finished, all games within the pool have been abandoned)

Selections String

Example \"1,2/1,8,10/13\"

The above string represents a ticket/coupon/bet in a pool that has 3 legs (the selections for each leg are separated by a /).\nThe first leg has the selections with the bin numbers 1 and 2, second leg the bin numbers 1,8,10 and so on.

For most type_codes the above would represent 6 lines (2 x 3 x 1), however for some racing type pools (race order), some lines can be invalid and the valid lines calculation is more complex.

Pool Prizes

Currently, our system supports a win pool prize and up to 5 consolation prizes depending on the sport_code, type_code and the number of legs.\nEach pool will have an association of at least one pool prize, differentiated by a prize code. All the prizes are distributed between the corresponding winning units accordingly.\nA ticket with multiple lines, can win different consolations for the loosing lines that did not qualify for a higher prize.

For example, for a FOOTBALL HDA PICK 15:\n\n(_ni - representing the prize for x - i out of x winning linesm where x is the total nr of legs in the pool)\n* WIN    - prize for 15/15 correct results lines\n* CON_N1 - prize for 14/15 correct results lines\n* CON_N2 - prize for 13/15 correct results lines\n* CON_N3 - prize for 12/15 correct results lines\n* CON_N4 - prize for 11/15 correct results lines\n* CON_N5 - prize for 10/15 correct results lines\n

","event":[{"listen":"prerequest","script":{"id":"6bc8d489-3999-44c9-90af-6f8a0d28610c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"bb5800e7-ef62-4314-a2b8-fd89ccabe147","type":"text/javascript","exec":[""]}}],"_postman_id":"2908415e-6648-7a3d-c1f5-a9b38bea7bf2"}],"event":[{"listen":"prerequest","script":{"id":"704086b8-b601-442e-9b7a-14bd3374142f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"b574b7e9-f947-4b07-9173-cf39bcc31720","type":"text/javascript","exec":[""]}}]}

About us

Units

Fx Rates

Wallet Api Token Auth

Token Header Format

sign_in - POST /users/sign_in

Response example

`PoolItemData` Response example

Additional response info

Response example

Response example

Response example

Additional response info

Response example

Response example

Sport Codes

Type Codes

Pool Status Codes

Selections String

Pool Prizes

sign_in - POST `/users/sign_in`