You are on page 1of 19

Delaware - API Documention

Introduction
Methods
BTCheckTxByBarcode
Request shape
Response shape
BTClaimReceipt
Request shape
Response shape
BTConfirmSlip
Request shape
Response shape
BTGetTerminalParameters
Request shape
Response shape
BTHeartBeat
Request shape
Response shape
BTIssueCashReceipt
Request shape
Response shape
BTPlaceSlip2
Request shape
Response shape
BTRejectSlip
Request shape
Response shape
BTSessionStats
Request shape
Response shape
BTTerminalCashboxStats
Request shape
Response shape
BTTerminalDeposit
Request shape
Response shape
CalculateBetSlip
Request shape
Response shape
GetAllowedBetTypesWithCalculations
Request shape
Response shape
Example
Request
Response
GetBookedBetSlip
Request shape
Response shape
Example
Request
Response
LogAppEvent
Request shape
Response shape
OperatorLogin
Request shape
Response shape
OPOperatorTransfer
Request shape
Response shape
OPPrepareReportString
Request shape
Response shape
RegisterTerminal
Request shape
Response shape
TerminalLogin
Request shape
Response shape
Exceptions codes
Appendix - Entity Details
BetSlip DetailedState
BetSlip State
DisplayBet Entity
DisplayBetLeg Entity

Introduction
The purpose of this document is to explain what the exposed methods of the Delaware API do with its transport objects and each of their variables.

Methods
The methods that can be found in the API are the following:

BTCheckTxByBarcode
This method allows a barcode to visualize a bet.
Request shape

Attribute Type Description

idBTTerminal string unique terminal identifier

idDCSession string terminal session of the system used in the request

barcode string transaction code

Response shape

Parent group Attribute Type Description

IDBTTransactionType string Type of transaction, they can be of the following type:

ST - Anonymous betting slip placement


VC - Terminal cash voucher issue

IDBTSlipState string Displays the status of the selected bet, which can be one of the following:

F - Failed
O - Open
U - Unpaid
C - Closed

IDBTCashReceiptState string Statements of cash receipts:

O - On authorization
U - Payable
C - Paid

AmountPayout decimal amount payable

BetSlip\Bets DisplayBet Check DisplayBet Entity

BetSlip\Bets\DisplayBet DisplayBetLeg Check DisplayBetLeg Entity

BetSlip ID decimal betslip identifier

BetSlip IDBTTransaction decimal terminal transaction id

BetSlip PlacementTime dateTime the exact date on which the bet was placed

BetSlip SalespointNumber decimal Sales site number

BetSlip Currency string Currency

BetSlip IDMMCurrency string id of the currency

BetSlip SalespointName string name of the point of sale

BetSlip SalespointAddress string point of sale address

BetSlip BetSlipExt

IsFree boolean determines whether the bet is free or not

CardNumber string Loyalty program card number registered

BTClaimReceipt
This method is used to redeem the money from a voucher that we have with money.

Request shape

Attribute Type Description

idBTTerminal string unique terminal identifier

idDCSession string terminal session of the system being used in the request

terminalsReference string reference owned by the terminal

Response shape

Attribute Type Description

CashAmountReceived decimal amount of money received

FreeAmountReceived decimal free money received

NewCashSessionBalance decimal the new amount of money available in the idDCSession session
NewFreeSessionBalance decimal new amount of free money available for the idDCSession

BTConfirmSlip
Confirm an attempted slip when a confirmation is required, for example when a reoffer is received.

Request shape

Parent Group Attribute Type Description

idBTTerminal string terminal identifier

idDCSession string terminal session being used

terminalsReference string terminal reference

isPossibleDuplicate boolean check if transfer could be duplicate, for example if you retry a failed previous transfer

isFree boolean Indicates if the bet slip was placed using free bet

amountTopup decimal amount topup, default 0

IDMMBusinessUnit decimal Business Unit ID

IDDCLanguage string Language ID

IDMMCustomer decimal Customer ID

IDBTTransaction decimal BTTransaction ID

IDFOBetSlip decimal Bet Slip ID to confirm

DetailedState int Check BetSlip Detailed State

State int Check BetSlip State

StatusCode string status code

StatusText string status description

TotalStake decimal total stake amount

TxTimeStamp dateTime date

slipCouponReference string Slip reference

soBetTypesAmount\SOBonus IDFOBetType string Bet type where bonus amount (special offer) is applied

soBetTypesAmount\SOBonus SOBonusAmount decimal Bonus (special offer) amount

Response shape
For the response, we will receive an object of type BTConfirmSlipResult with following attributes:

Parent Group Attribute Type Description

Status DetailedState int Check BetSlip Detailed State

Status State int Check BetSlip State

Status StatusCode string Could be open (O), closed (C), attempted (A)

Status StatusText string status description

SlipBarcode string betslip barcode

AmountSlip decimal Slip amount

AmountCommission decimal Commission on bet placement amount

CommissionOnPayout decimal Commission on Payout amount

TaxOnWinning decimal Tax amount on Winnings

CurrentCashBalance decimal Current cash balance

CurrentFreeBalance decimal Current free balance

BetSlip\Bets DisplayBet Entity Check DisplayBet Entity

BetSlip ID decimal BetSlip ID

BetSlip IDBTTransaction decimal BTTransaction ID

BetSlip PlacementTime dateTime Slip placement date

BetSlip SalespointNumber decimal Salespoint / Shop number

BetSlip Currency string unique Currency

BetSlip IDMMCurrency string unique Currency ID


BetSlip SalespointName string Salespoint / Shop name

BetSlip SalespointAddress decimal Salespoint / Shop address

BetSlip IsFree boolean determines whether the betslip is free or not

BetSlip CardNumber string Loyalty program card number

ConfirmationRequiredState IDBTTerminal string unique BTTerminal ID

ConfirmationRequiredState IDDCSession string Terminal Session

ConfirmationRequiredState TerminalsReference string Terminal Reference

ConfirmationRequiredState IsPossibleDuplicate boolean check if the transaction could be duplicate, for example, if you retry a failed previous transfer

ConfirmationRequiredState IsFree boolean determines whether the betslip is free or not

ConfirmationRequiredState AmountTopup decimal topup amount

ConfirmationRequiredState IDMMBusinessUnit decimal unique Business Unit ID

ConfirmationRequiredState IDDCLanguage string unique Language ID

ConfirmationRequiredState IDMMCustomer decimal unique Customer ID

ConfirmationRequiredState IDBTTransaction decimal unique BTTransaction ID

ConfirmationRequiredState IDFOBetSlip decimal unique Slip ID

ConfirmationRequiredState DetailedState int Check BetSlip Detailed State

ConfirmationRequiredState State int Check BetSlip State

ConfirmationRequiredState StatusCode string Could be open (O), closed (C), attempted (A)

ConfirmationRequiredState StatusText string status description

ConfirmationRequiredState TotalStake decimal Total stake amount

ConfirmationRequiredState TxTimeStamp dateTime date

ConfirmationRequiredState SlipCouponReference string Slip reference

OutboundBets\DisplayBetOutbound ExternalReference string Bet External reference

OutboundBets\DisplayBetOutbound MaxTakeout decimal Max Takeout amount

OutboundBets\DisplayBetOutbound PotentialReturn decimal Potential return amount

OutboundBets\DisplayBetOutbound TotalStake decimal Total stake amount

OutboundBets\DisplayBetOutbound UnitCount int Number of units

OutboundBets\DisplayBetOutbound BetLegs Entity Check DisplayBetLeg Entity

OutboundBets\DisplayBetOutbound IDFOBetType string Bet Type

OutboundBets\DisplayBetOutbound IDFOMultiRacePool decimal Unique Multirace pool ID

OutboundBets\DisplayBetOutbound IsPool boolean determines whether the bet belongs to a pool

OutboundBets\DisplayBetOutbound PlaceStake decimal Stake amount placed

OutboundBets\DisplayBetOutbound WinStake decimal Stake

PromoCodes\PromoCodeData IDBTPromoVoucher string Unique ID of the promotional voucher generated

PromoCodes\PromoCodeData PromoCodeValue decimal Amount of promotional voucher

LoyaltyCardNumber string Loyalty program card number registered

BTGetTerminalParameters
This method is used to obtain terminal parameters that are previously saved. These parameters can be machine characteristics or machine specifications.
These parameters are managed by the RTM application.

Request shape
To make a request we must use a BTGetTerminalParameters object with the following parameters:

Attribute Type Description

idBTTerminal string unique terminal identifier

idDCSession string terminal session of the system used

Response shape
For the response, we will receive an object of type BTGetTerminalParametersResponse with the following attributes:

Attribute Type Description


IDBTParameter string ID of the parameter received

ValueString string parameter string value

ValueDate dateTime parameter date value

ValueNumber decimal parameter number value

ValueBlob Blob - Object parameter blob/object value. For example xml or json files.

BTHeartBeat
Check the connectivity and operation with delaware and the database. The heartbeat is logged in DBCORE.dcusereventlog with DBUSER =
'MMBTIAPPSERVER' and APPSERVICE, APPEVENTCODE and DETAILS = 'BTHeartBeat'

Request shape

Attribute Type Description

idBTTermi string terminal identifier


nal

idDCSessi string terminal session being used


on

Response shape
Empty object - 200 OK

BTIssueCashReceipt
This procedure can be used to request a voucher with the money available in the session by the user.

Request shape

Attribute Type Description

idBTTerminal string unique terminal identifier

idDCSession string terminal session of the system used in the request

terminalsReference string reference owned by the terminal

isPossibleDuplicate boolean check if the transfer could be duplicate, for example, if you retry a failed previous transfer

amountTopup decimal amount of money available for withdrawal

amountRequested decimal amount of money requested for withdrawal

Response shape

Attribute Type Description

NewSessionBalance decimal the new amount of money available in the idDCSession session

ReceiptBarcode string It is a string that accompanies the barcode on the voucher and allows the use of the money withdrawn

ExpiryDate dateTime voucher expiration date

BTPlaceSlip2
Method used to place a bet.

Request shape

Parent group Attribute Type Description

idBTTerminal string unique terminal identifier

idDCSession string session of the system used in the request

terminalsReference string reference owned by the terminal

playerBarcode string Player code / CNP

isPossibleDuplicate boolean check if the transaction could be duplicate, for example, if you retry a failed previous transfer
isFree boleean Indicates if the bet slip was placed using free bet

amountTopup decimal topup amount, default 0

BetSlipInbound/Bets DisplayBetLeg Check DisplayBetLeg Entity

slipCouponReference string Slip reference

stretchedPrices Not used

soBetTypesAmount/SOBonus IDFOBetType string Bet type where bonus amount (special offer) is applied

soBetTypesAmount/SOBonus SOBonusAmount decimal Bonus (special offer) amount

genPromoCode boolean Indicates if betslip can generate a promotional voucher code

Response shape

Parent group Attribute Type Description

BTPlaceSlip2Result/Status DetailedState int Check BetSlip Detailed State

BTPlaceSlip2Result/Status State int Check BetSlip State

BTPlaceSlip2Result/Status StatusCode string Could be open (O), closed (C), attempted (A)

BTPlaceSlip2Result/Status StatusText string status description

SlipBarcode string betslip barcode

AmountSlip decimal Amount staked

AmountCommission decimal Amount established in case there is a commission

CommissionOnPayout decimal Commission on payment

TaxOnWinning decimal rates established on profits

CurrentCashBalance decimal real money that the client has in the session

CurrentFreeBalance decimal free money available for betting e.g. the one available for a welcome bonus

BetSlip/Bets DisplayBet Check DisplayBet Entity

BetSlip ID decimal unique betslip identifier

BetSlip IDBTTransaction decimal unique identifier of the process via the terminal

BetSlip PlacementTime dateTime the exact date on which the bet was placed

BetSlip SalespointNumber decimal Sales site number

BetSlip Currency decimal Currency

BetSlip IDMMCurrency decimal id of the currency

BetSlip SalespointName string name of the point of sale

BetSlip SalespointAddress string point of sale address

BetSlip BetSlipExt

BetSlip IsFree boolean Indicates if the bet slip was placed using free bet

BetSlip CardNumber string Loyalty program card number registered

ConfirmationRequiredState IDBTTerminal string unique BTTerminal ID

ConfirmationRequiredState IDDCSession string Terminal Session

ConfirmationRequiredState TerminalsReference string Terminal Reference

ConfirmationRequiredState IsPossibleDuplicate boolean check if the transaction could be duplicate, for example, if you retry a failed previous transfer

ConfirmationRequiredState IsFree boolean determines whether the betslip is free or not

ConfirmationRequiredState AmountTopup decimal topup amount

ConfirmationRequiredState IDMMBusinessUnit decimal unique Business Unit ID

ConfirmationRequiredState IDDCLanguage string unique Language ID

ConfirmationRequiredState IDMMCustomer decimal unique Customer ID

ConfirmationRequiredState IDBTTransaction decimal unique BTTransaction ID

ConfirmationRequiredState IDFOBetSlip decimal unique Slip ID

ConfirmationRequiredState DetailedState int Check BetSlip Detailed State

ConfirmationRequiredState State int Check BetSlip State

ConfirmationRequiredState StatusCode string Could be open (O), closed (C), attempted (A)

ConfirmationRequiredState StatusText string status description

ConfirmationRequiredState TotalStake decimal Total stake amount

ConfirmationRequiredState TxTimeStamp dateTime date


ConfirmationRequiredState SlipCouponReference string Slip reference

OutboundBets\DisplayBetOutbound ExternalReference string Bet External reference

OutboundBets\DisplayBetOutbound MaxTakeout decimal Max Takeout amount

OutboundBets\DisplayBetOutbound PotentialReturn decimal Potential return amount

OutboundBets\DisplayBetOutbound TotalStake decimal Total stake amount

OutboundBets\DisplayBetOutbound UnitCount int Number of units

OutboundBets\DisplayBetOutbound BetLegs Entity Check DisplayBetLeg Entity

OutboundBets\DisplayBetOutbound IDFOBetType string Bet Type

OutboundBets\DisplayBetOutbound IDFOMultiRacePool decimal Unique Multirace pool ID

OutboundBets\DisplayBetOutbound IsPool boolean determines whether the bet belongs to a pool

OutboundBets\DisplayBetOutbound PlaceStake decimal Stake amount placed

OutboundBets\DisplayBetOutbound WinStake decimal Stake

PromoCodes\PromoCodeData IDBTPromoVoucher string Unique ID of the promotional voucher generated

PromoCodes\PromoCodeData PromoCodeValue decimal Amount of promotional voucher

LoyaltyCardNumber string Loyalty program card number registered

BTRejectSlip
Reject an attempted slip when a confirmation is required, for example when a reoffer is received.

Request shape

Attribute Type Description

idBTTerminal string terminal identifier

idDCSession string terminal session being used

terminalsReference string terminal reference

isPossibleDuplicate boolean check if transaction could be duplicate, for example if you retry a failed previous transfer

isFree boolean Indicates if the bet slip was placed using free bet

amountTopup decimal amount topup, default 0

IDMMBusinessUnit decimal Business Unit ID

IDDCLanguage string Language ID

IDMMCustomer decimal Customer ID

IDBTTransaction decimal BTTransaction ID

IDFOBetSlip decimal Bet Slip ID to confirm

DetailedState int Check BetSlip Detailed State

State int Check BetSlip State

StatusCode string Could be open (O), closed (C), attempted (A)

StatusText string Status description

TotalStake decimal Total Stake amount

TxTimeStamp dateTime date

slipCouponReference string Slip reference

Response shape
Empty object - 200 OK

BTSessionStats
Returns data related to the balance of the current terminal session.

Request shape
To make a request, an object of type BTSessionStats is used with the following attributes:
Attribute Type Description

idBTTerminal string unique terminal identifier

idDCSession string terminal session of the system used

Response shape
Returns an object of type BTSessionStatsResponse with the following properties:

Attribute Type Description

CurrentCashBalance decimal real money that the client has in the session right now

CurrentFreeBalance decimal free money available for betting e.g. the one available for a welcome bonus

BTTerminalCashboxStats
Perform an operator transfer between two accounts (for example from terminal to shop).

Request shape

Attribute Type Description

idBTTermi string terminal identifier


nal

idDCSessi string terminal session being used


on

Response shape
For the response, we will receive an object of type BTTerminalCashboxStatsResult with the following attribute:

Attribute Type Description

CurrentBalance decimal current balance from terminal cash box

BTTerminalDeposit
Method used to make cash deposits.

Request shape

Attribute Type Description

idBTTerminal string unique terminal identifier

idDCSession string terminal session of the system used in the request

terminalsReference string reference owned by the terminal

isPossibleDuplicate boolean check if the transfer could be duplicate, for example, if you retry a failed previous transfer

amountDeposited decimal amount of money to deposit

Response shape

Attribute Type Description

NewSessionBalance decimal New balance sheet

NewCashboxBalance decimal New balance available in the cash box

CalculateBetSlip
Returns betslip calculations.

Request shape

Parent group Attribute Type Description


idBTTerminal string unique terminal identifier

idDCSession string session of the system used in the request

BetSlipInbound/Bets/BetInbound BetLegs Check DisplayBetLeg Entity

BetVoucherType Only used with vouchers

Response shape
This will give us an array of CalculateBetSlipResult with the following attributes:

Attribute Type Description

PotentialReturn decimal amount of money to be obtained in case of winning the bet

TotalStake decimal amount of money bet

UnitCount int Number of units

GetAllowedBetTypesWithCalculations
Return allowed bet types with potential return calculated for each bet type.

Request shape

Attribute Type Description

idBTTermi string terminal identifier


nal

idDCSessi string terminal session being used


on

Handicap decimal Optional. Selection Handicap

UpperBand decimal Optional. Selection Upper band

LowerBand decimal Optional. Selection Lower band

IDFOPrice string Selection Price type


Type

IDFOSelec decimal Selection ID


tion

PriceDown decimal Selection Price Down

PriceUp decimal Selection Price Up

EachWayR decimal Each Way Reduction value


eduction

EachWayP decimal Each Way Place Terms value


laceTerms

SystemTag string Optional. System tag

IsTrap boolean Is trap selection

Interrelatio string Optional. Interrelation tag


nTag

IDFOEvent decimal Optional. Event scorecast


Scorecast

Response shape
For the response, we will receive an object of type GetAllowedBetTypesWithCalculationsResult with an array of CalculateBetType objects with following
attributes:

Parent Group Attribute Type Description

IDFOBetType string Bet Type

IsEachWayAllowed boolean Each Way allowed for this bet type

Name string Name of bet type

CalculatedBet PotentialReturn decimal Potential return

CalculatedBet TotalStake decimal Total stake

CalculatedBet UnitCount int Unit count


Example

Request

GetAllowedBetTypesWithCalculations

<?xml version="1.0" encoding="utf-8"?>


<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001
/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetAllowedBetTypesWithCalculations xmlns="http://Com.Finsoft.Warp.Delaware.Remote.Transactional/">
<idBTTerminal>SSBT3-1</idBTTerminal>
<idDCSession>82BC31C443DEA21AF04CC1E7D0E19DA4</idDCSession>
<BetInbound xmlns="http://Com.Finsoft.Warp.Texas.Common/">
<BetLegs>
<BetLeg>
<IDFOPriceType>CP</IDFOPriceType>
<IDFOSelection>184883290.1</IDFOSelection>
<PriceDown>5</PriceDown>
<PriceUp>2</PriceUp>
<EachWayReduction>1</EachWayReduction>
<EachWayPlaceTerms>1</EachWayPlaceTerms>
<IsTrap>false</IsTrap>
<!--<Handicap></Handicap>
<UpperBand></UpperBand>
<LowerBand></LowerBand>
<SystemTag></SystemTag>
<InterrelationTag></InterrelationTag>
<IDFOEventScorecast></IDFOEventScorecast>-->
</BetLeg>
<BetLeg>
<IDFOPriceType>CP</IDFOPriceType>
<IDFOSelection>184037608.1</IDFOSelection>
<PriceDown>2</PriceDown>
<PriceUp>17</PriceUp>
<EachWayReduction>1</EachWayReduction>
<EachWayPlaceTerms>1</EachWayPlaceTerms>
<IsTrap>false</IsTrap>
<!--<Handicap></Handicap>
<UpperBand></UpperBand>
<LowerBand></LowerBand>
<SystemTag></SystemTag>
<InterrelationTag></InterrelationTag>
<IDFOEventScorecast></IDFOEventScorecast>-->
</BetLeg>
<BetLeg>
<IDFOPriceType>CP</IDFOPriceType>
<IDFOSelection>184905526.1</IDFOSelection>
<PriceDown>7</PriceDown>
<PriceUp>4</PriceUp>
<EachWayReduction>1</EachWayReduction>
<EachWayPlaceTerms>1</EachWayPlaceTerms>
<IsTrap>false</IsTrap>
<!--<Handicap></Handicap>
<UpperBand></UpperBand>
<LowerBand></LowerBand>
<SystemTag></SystemTag>
<InterrelationTag></InterrelationTag>
<IDFOEventScorecast></IDFOEventScorecast>-->
</BetLeg>
</BetLegs>
</BetInbound>
</GetAllowedBetTypesWithCalculations>
</soap:Body>
</soap:Envelope>

Response
GetAllowedBetTypesWithCalculations Response

<?xml version="1.0" encoding="utf-8"?>


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001
/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetAllowedBetTypesWithCalculationsResponse xmlns="http://Com.Finsoft.Warp.Delaware.Remote.Transactional
/">
<GetAllowedBetTypesWithCalculationsResult>
<CalculatedBetType>
<IDFOBetType>C1</IDFOBetType>
<IsEachWayAllowed>true</IsEachWayAllowed>
<Name>Straights</Name>
<CalculatedBet>
<PotentialReturn>12.4714285714286</PotentialReturn>
<TotalStake>3</TotalStake>
<UnitCount>3</UnitCount>
</CalculatedBet>
</CalculatedBetType>
<CalculatedBetType>
<IDFOBetType>C2</IDFOBetType>
<IsEachWayAllowed>true</IsEachWayAllowed>
<Name>2 Pick Round Robin</Name>
<CalculatedBet>
<PotentialReturn>30.4285714285714</PotentialReturn>
<TotalStake>3</TotalStake>
<UnitCount>3</UnitCount>
</CalculatedBet>
</CalculatedBetType>
<CalculatedBetType>
<IDFOBetType>T</IDFOBetType>
<IsEachWayAllowed>true</IsEachWayAllowed>
<Name>3 Pick Parlay</Name>
<CalculatedBet>
<PotentialReturn>20.9</PotentialReturn>
<TotalStake>1</TotalStake>
<UnitCount>1</UnitCount>
</CalculatedBet>
</CalculatedBetType>
<CalculatedBetType>
<IDFOBetType>P</IDFOBetType>
<IsEachWayAllowed>true</IsEachWayAllowed>
<Name>Patent</Name>
<CalculatedBet>
<PotentialReturn>63.8</PotentialReturn>
<TotalStake>7</TotalStake>
<UnitCount>7</UnitCount>
</CalculatedBet>
</CalculatedBetType>
<CalculatedBetType>
<IDFOBetType>TX</IDFOBetType>
<IsEachWayAllowed>true</IsEachWayAllowed>
<Name>Trixie</Name>
<CalculatedBet>
<PotentialReturn>51.3285714285714</PotentialReturn>
<TotalStake>4</TotalStake>
<UnitCount>4</UnitCount>
</CalculatedBet>
</CalculatedBetType>
</GetAllowedBetTypesWithCalculationsResult>
</GetAllowedBetTypesWithCalculationsResponse>
</soap:Body>
</soap:Envelope>

GetBookedBetSlip
Return the bet slip associated with the given ID (Bet code)

Request shape

Attribute Type Description


idBTTermi string terminal identifier
nal

idDCSessi string terminal session being used


on

idFOBetSlip decimal Bet code (Bet Slip ID)

Response shape
For the response, we will receive an object of type GetBookedBetSlipResult with the Betslip data and an array of DisplayBets objects with following attributes:

Parent Group Attribute Type Description

ID decimal Bet Slip ID

IDBTTransaction decimal BTI Transaction ID

PlacementTime datetime Bet slip placement date

SalespointNumb decimal Salespoint / Shop number


er

Currency string currency

IDMMCurrency string Currency ID

SalespointName string Salespoint / Shop name

SalespointAddre string Salespoint / Shop address


ss

IsFree boolean Indicates if the bet slip was placed using free bet

CardNumber string Loyalty program card number registered

Bets DisplayBet Check DisplayBet Entity

Bets\DisplayBet BetLegs Check DisplayBetLeg Entity

Example

Request

GetBookedBetSlip Request

<?xml version="1.0" encoding="utf-8"?>


<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001
/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetBookedBetSlip xmlns="http://Com.Finsoft.Warp.Delaware.Remote.Transactional/">
<idBTTerminal>SSBT3-1</idBTTerminal>
<idDCSession>82BC31C443DEA21AF04CC1E7D0E19DA4</idDCSession>
<idFOBetSlip>220420</idFOBetSlip>
</GetBookedBetSlip>
</soap:Body>
</soap:Envelope>

Response

GetBookedBetSlip Response

<?xml version="1.0" encoding="utf-8"?>


<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001
/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Body>
<GetBookedBetSlipResponse xmlns="http://Com.Finsoft.Warp.Delaware.Remote.Transactional/">
<GetBookedBetSlipResult>
<Bets>
<DisplayBet>
<BetLegs>
<DisplayBetLeg>
<PriceUp>1</PriceUp>
<PriceDown>1</PriceDown>
<IDFOPriceType>CP</IDFOPriceType>
<IDFOMarket>0</IDFOMarket>
<TSRealStart xsi:nil="true" />
<MinimumUnitSize xsi:nil="true" />
<IDFOSelection>185478340.10</IDFOSelection>
<IsTrap>false</IsTrap>
<IDFOEventScorecast xsi:nil="true" />
<Handicap xsi:nil="true" />
<MarketBetEnd xsi:nil="true" />
<LegOrder xsi:nil="true" />
<IDFOBand xsi:nil="true" />
<OwnLowerBand xsi:nil="true" />
<OwnUpperBand xsi:nil="true" />
<MarketOffTime xsi:nil="true" />
<CompetitorNumber xsi:nil="true" />
<HomeScoreLine xsi:nil="true" />
<AwayScoreLine xsi:nil="true" />
<HTHomeScoreLine xsi:nil="true" />
<HTAwayScoreLine xsi:nil="true" />
<VoidFactor xsi:nil="true" />
<SelectionHandicap xsi:nil="true" />
<OwnMultiPriceUp xsi:nil="true" />
<OwnMultiPriceDown xsi:nil="true" />
</DisplayBetLeg>
<DisplayBetLeg>
<PriceUp>4</PriceUp>
<PriceDown>5</PriceDown>
<IDFOPriceType>CP</IDFOPriceType>
<IDFOMarket>0</IDFOMarket>
<TSRealStart xsi:nil="true" />
<MinimumUnitSize xsi:nil="true" />
<IDFOSelection>185487214.10</IDFOSelection>
<IsTrap>false</IsTrap>
<IDFOEventScorecast xsi:nil="true" />
<Handicap xsi:nil="true" />
<MarketBetEnd xsi:nil="true" />
<LegOrder xsi:nil="true" />
<IDFOBand xsi:nil="true" />
<OwnLowerBand xsi:nil="true" />
<OwnUpperBand xsi:nil="true" />
<MarketOffTime xsi:nil="true" />
<CompetitorNumber xsi:nil="true" />
<HomeScoreLine xsi:nil="true" />
<AwayScoreLine xsi:nil="true" />
<HTHomeScoreLine xsi:nil="true" />
<HTAwayScoreLine xsi:nil="true" />
<VoidFactor xsi:nil="true" />
<SelectionHandicap xsi:nil="true" />
<OwnMultiPriceUp xsi:nil="true" />
<OwnMultiPriceDown xsi:nil="true" />
</DisplayBetLeg>
</BetLegs>
<ID>0</ID>
<IDMMBusinessDay>0</IDMMBusinessDay>
<IDMMBusinessDayDate>0001-01-01T00:00:00</IDMMBusinessDayDate>
<TotalStake>1000</TotalStake>
<PotentialReturn>0</PotentialReturn>
<TotalReturn xsi:nil="true" />
<UnitStakeWin>1000</UnitStakeWin>
<UnitStakePlace xsi:nil="true" />
<UnitStakeShow xsi:nil="true" />
<IfAllPlaceReturn xsi:nil="true" />
<SOReturn xsi:nil="true" />
<IDBetType>D</IDBetType>
<IsCancelled>false</IsCancelled>
<BetPlacementTime>0001-01-01T00:00:00</BetPlacementTime>
<NumberOfUnits xsi:nil="true" />
<MaxTakeout xsi:nil="true" />
<SumPartialStake>0</SumPartialStake>
<SumPartialReturn>0</SumPartialReturn>
<SpreadPoints>0</SpreadPoints>
<BetPrice>0</BetPrice>
</DisplayBet>
</Bets>
<ID>0</ID>
<IDBTTransaction>0</IDBTTransaction>
<PlacementTime>0001-01-01T00:00:00</PlacementTime>
<SalespointNumber>0</SalespointNumber>
<IsFree>false</IsFree>
</GetBookedBetSlipResult>
</GetBookedBetSlipResponse>
</soap:Body>
</soap:Envelope>
LogAppEvent
Log event in database

Request shape

Attribute Type Description

idBTTermi string terminal identifier


nal

idDCSessi string terminal session being used


on

appObject string Identifier of product, for example 'SSBT'

appService string Identifier of service or event

param1 string Optional. Parameter name

value1 string Optional. Parameter value

param2 string Optional. Parameter name

value2 string Optional. Parameter value

param3 string Optional. Parameter name

value3 string Optional. Parameter value

param4 string Optional. Parameter name

value4 string Optional. Parameter value

param5 string Optional. Parameter name

value5 string Optional. Parameter value

param6 string Optional. Parameter name

value6 string Optional. Parameter value

param7 string Optional. Parameter name

value7 string Optional. Parameter value

param8 string Optional. Parameter name

value8 string Optional. Parameter value

param9 string Optional. Parameter name

value9 string Optional. Parameter value

param10 string Optional. Parameter name

value10 string Optional. Parameter value

Response shape
Empty object - 200 OK

OperatorLogin
Performs an authentication action for the operator. An object of type OperatorLogin is sent with the following attributes:

Request shape

Attribute Type Description

idBTOperator string operator identifier

sPassword string operator password to authenticate in the system

idBTTerminal string unique terminal identifier

Response shape
This request returns a list of the Privilege object, which has the following attributes:
Attribute Type Description

IDDCApplication string Application on the system on which the privilege is obtained

ObjectCode string DBCore object code

IDDCAction string DBCore action allowed for this object

IDDCReaction string DBCore reaction for this object

For more information regarding system attributes (DBCore objects), please read the DBCore Admin user guide.

OPOperatorTransfer
Perform an operator transfer between two accounts (for example from terminal to shop).

Request shape

Attribute Type Description

idBTOperator string operator identifier

idDCSession string operator session being used

idBTTransferType string transfer type

terminalsReference string terminal reference

isPossibleDuplicate boolean check if transfer could be duplicate, for example if you retry a failed previous transfer

amountTransferred decimal amount of transfer

operatorsNote string notes of transfer (optional)

Response shape
For the response, we will receive an object of type OPOperatorsTransferResult with the following attributes:

Attribute Type Description

NewBalance1 decimal current balance from origin account

NewBalance2 decimal current balance from destination account

OPPrepareReportString
Generate a report. The response is a fully formatted text string with the report content to be printed as is.

Request shape

Attribute Type Description

idBTOperat string operator identifier


or

idDCSessi string operator session being used


on

idBTReport string Report Type. Check different report types defined.


Type

param01V string Mandatory . Date FROM


alue

param02V string Mandatory . Date TO


alue

param03V string Optional. Null. Not used.


alue

param04V string Optional. Null. Not used.


alue

param05V string Optional. Null. Not used.


alue
param06V string Optional. Null. Not used.
alue

param07V string Optional. Null. Not used.


alue

param08V string Optional. Null. Not used.


alue

param09V string Optional. Null. Not used.


alue

param10V string Optional. Null. Not used.


alue

param11V string Optional. Null. Not used.


alue

param12V string Optional. Null. Not used.


alue

param13V string Optional. Null. Not used.


alue

param14V string Optional. Null. Not used.


alue

param15V string Optional. Null. Not used.


alue

param16V string Optional. Null. Not used.


alue

Response shape
For the response, we will receive an object of type OPPrepareReportStringResult with the following attribute:

Attribute Type Description

OPPrepareReportStringResult string fully formatted text string with the report content

RegisterTerminal
Register a new terminal in the system.

Request shape

Attribute Type Description

hashedReq string hashedRequest = String .format("n>3$%s$%s$%s$e]\\", terminalCode, Base64.getEncoder().encodeToString(String .format("j&h


uest %sr[\/", terminalCode).getBytes()), OffsetDateTime.now());

Response shape
Empty object - 200 OK

TerminalLogin
Performs a login action in the system.

Request shape

Attribute Type Description

idBTTerminal string unique terminal identifier

sPassword string terminal password to authenticate in the system: Password = String .format("j&h%sr[\/", terminalCode)

sTerminalVersion string terminal system version

Response shape
Empty object - 200 OK

Exceptions codes
Code Description Remarks

0080010088 Terminal is Inactive in RTM Check terminal status in RTM

0080020088 DCUser of terminal is inactive Check DCUser is active in DBCore Admin app

0080100088 Salespoint is Inactive in RTM Check Salepoint (Shop) is active in RTM

0080110088 Partner is Inactive in RTM Check Partner is active in RTM

0060040088 Terminal Code does not exist Check terminal code

Appendix - Entity Details


Details of entities used in request and responses

BetSlip DetailedState

Code Name Summary Remarks

0 AbortPro This means that an exceptional case has occurred. The equivalent to throwing Check StatusText/StatusCode for further details.BetSlipStatus.State
cessing an exception, but this state will persist the original transaction.All processing is = Rejected
aborted.

1 Accepta This means that the BetSlip has been successfully registered but requires BetSlipStatus.State = Acceptable
ble confirmation. BetSlip is flagged as Attempted and will remain in that state until
ConfirmBetSlip has been called and successfully completed.

2 Accepted This means that the BetSlip has been successfully registered and confirmed. BetSlipStatus.State = Accepted
BetSlip is flagged as Open and no further action is required.

3 BandCh This means that the current Band (Lower/Upper) offered against a selection is Will usually be combined with Acceptable DetailedBetSlipStatus.A
anged different than the Band value that was passed during PlaceBetSlip.BetSlip is DetailedState of [Acceptable, BandChanged] will have a State of
flagged as Attempted and will remain in that state until ConfirmBetSlip has ConfirmationRequired.
been called and successfully completed.

4 EachWa This means that the current EachWay (PlaceTerms/Reduction) offered against Will usually be combined with Acceptable DetailedBetSlipStatus.A
yChanged a selection is different than the EachWay value that was passed during DetailedState of [Acceptable, EachWayChanged] will have a State
PlaceBetSlip.BetSlip is flagged as Attempted and will remain in that state until of ConfirmationRequired.
ConfirmBetSlip has been called and successfully completed.

5 Handica This means that the current Handicap offered against a selection is different Will usually be combined with Acceptable DetailedBetSlipStatus.A
pChang than the Handicap value that was passed during PlaceBetSlip.BetSlip is DetailedState of [Acceptable, HandicapChanged] will have a State
ed flagged as Attempted and will remain in that state until ConfirmBetSlip has of ConfirmationRequired.
been called and successfully completed.

6 MaxTak This means that the Potential Return for the bet exceeds the Maximum BetSlipStatus.State = ConfirmationRequired
eoutViol Takeout allow for the bet and it will be capped.Requires customer to confirm
ation the Potential Return cap.

7 PreProc You should never receive this. This is the initialised value of the DetailedState BetslipStatus.State = PreProcess
ess property.If you do receive this value, then there isn't a DetailedState bitwise
mapping for the value returned from the database. Please report these
incidents via CIP.

8 PriceCh This means that the current Price offered against a selection is worse than the Will usually be combined with Acceptable DetailedBetSlipStatus.
anged Price that was passed during PlaceBetSlip.BetSlip is flagged as Attempted
and will remain in that state until ConfirmBetSlip has been called and
successfully completed.

9 Referred This means that the bet has been internally referred for verification. A call to GetBetSlipStatus will poll the betslip for its current status.
BetSlipStatus.State = Waiting

10 Rejected This means that the BetSlip has been rejected. StatusText and StatusCode Can be combined with xxxChanged DetailedBetSlipStatus.
should reveal details as to why it was rejected. BetSlipStatus.State = Rejected

11 Reoffered This means that the Bet has violated some ARC rules and ARC has changed Will usually be combined with Acceptable DetailedBetSlipStatus.A
/reduced the passed Stake so the rules are not broken.BetSlip is flagged as DetailedState of [Acceptable, Reoffered] will have a State of
Attempted and will remain in that state until ConfirmBetSlip has been called ConfirmationRequired.
and successfully completed.

12 ReofferT This means that the BetSlip was not confirmed within the timeout period.Bet is BetSlipStatus.State = Rejected
imeout automatically rejected.

13 Security This means that the customer does not have sufficient funds to place the bet BetSlipStatus.State = ConfirmationRequired
CodeRe and a topup is required and in addition customer security code is also required.
quiredFo Requires customer to confirm that a topup will be taken to cover the bet.Only
rTopup applicable for customers with InstantTopup cards.

14 TopupR This means that the customer does not have sufficient funds to place the bet BetSlipStatus.State = ConfirmationRequired
equired and a topup is required.Requires customer to confirm that a topup will be
taken to cover the bet.Only applicable for customers with InstantTopup cards.

15 Waiting This means that an asynchronous process has been called. Currently only returned during the following scenarios:when a
TopupRequired is confirmed and the Payment is an async one
when a Bet is internally referred.A call to GetBetSlipStatus will poll
the betslip for its current status.BetslipStatus.State = Waiting
BetSlip State

Code Name Summary Remarks

0 AllStates Combination of all states

1 Attempted Bet attempted (not open/valid) FOBETSTATE value = A

2 Cancelled Bet has been cancelled TXBETHISTORY_V value = X. No FOBETSTATE value. This is a synthetic value

3 Closed Bet closed FOBETSTATE value = C

4 Opened Bet opened FOBETSTATE value = O

5 Settled Bet Closed and Manually Settled FOBETSTATE value = C, ISMANUALLYSETTLED=true

6 Undefined Bet undefined FOBETSTATE value = ?

DisplayBet Entity

Attribute Type Description

IDMMBusinessDay decimal Business Day ID

IDMMBusinessDayDate dateTime Business Day in date

BetType string Bet Type

BetStatus string Bet Status: Open, Attempted... (Not apply for Bet Code - GetBookedBetSlip)

TotalStake decimal Bet Total Stake

PotentialReturn decimal Bet Potential Return

TotalReturn decimal Bet Total Return

UnitStakeWin decimal Win part of the bet unit stake, assumed to be unit stake

UnitStakePlace decimal Place part of the bet unit stake

UnitStakeShow decimal Show part of the bet unit stake

IfAllPlaceReturn decimal Potential return is all selections place

SOReturn decimal Special offer returns

IDBetType string Bet Type ID

Reference string Bet Reference

IsCancelled boolean Is Bet cancelled

BetPlacementTime dateTime DateTime value when bet placement occured

IDMMBusinessUnit string Business Unit ID

NumberOfUnits int Number of units

MaxTakeout decimal Maximum Takeout

SumPartialStake decimal Summary of Partial Stake cashout

SumPartialReturn decimal Summary of Partial Return cashout

SpreadPoints decimal Spreadpoints - Teaser applied

BetPrice decimal Bet Price

DisplayBetLeg Entity

Attribute Type Description

PriceUp string Price UP used by Bet (depending on the Price Type)

PriceDown string Price DOWN used by Bet (depending on the Price Type)

IDFOPriceType string Price type for bet leg AP, BP, FCD,TCD etc.

IDFOMarket decimal Unique ID of the Market.

TSRealStart dateTime Real starting time of the Event. By default taking the value from Promoted time, but may be edited by the Bookie.
MinimumUnitSize decimal Minimal size of units. I.e. if 3 then singles and double are now allowed.
Only bets that have units with 3 or more selections are accepted.

IDFOSelection decimal Unique ID of the Selection

IsTrap boolean Returns true if Leg is backing 'Runner name' or 'Trap number'. It is always true if bet is within some pool.

IDFOEventScorec decimal ID of Scorecast 'Market' for the scorecast leg pair


ast

Handicap decimal Handicap value

MarketBetEnd dateTime Market startting time is actualy market bet end time

LegOrder int Order of leg in the bet

IDFOBand decimal Unique ID of Band

OwnLowerBand decimal Lower Band value

OwnUpperBand decimal Upper Band value

MarketOffTime dateTime Time when market finished and went to off

CompetitorNumber decimal Number of competitor

HomeScoreLine decimal Home scoreline

AwayScoreLine decimal Away scoreline

HTHomeScoreLine decimal HT Home scoreline

HTAwayScoreLine decimal HT Away scoreline

VoidFactor decimal Void factor. If leg is partially voided.

SelectionHandicap decimal Handicap of the selection.

OwnMultiPriceUp decimal Multiple Bets Price Up

OwnMultiPriceDo decimal Multiple Bets Price Down


wn

You might also like