Professional Documents
Culture Documents
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
Response shape
IDBTSlipState string Displays the status of the selected bet, which can be one of the following:
F - Failed
O - Open
U - Unpaid
C - Closed
O - On authorization
U - Payable
C - Paid
BetSlip PlacementTime dateTime the exact date on which the bet was placed
BetSlip BetSlipExt
BTClaimReceipt
This method is used to redeem the money from a voucher that we have with money.
Request shape
idDCSession string terminal session of the system being used in the request
Response shape
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
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
soBetTypesAmount\SOBonus IDFOBetType string Bet type where bonus amount (special offer) is applied
Response shape
For the response, we will receive an object of type BTConfirmSlipResult with following attributes:
Status StatusCode string Could be open (O), closed (C), attempted (A)
ConfirmationRequiredState IsPossibleDuplicate boolean check if the transaction could be duplicate, for example, if you retry a failed previous transfer
ConfirmationRequiredState StatusCode string Could be open (O), closed (C), attempted (A)
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:
Response shape
For the response, we will receive an object of type BTGetTerminalParametersResponse with the following attributes:
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
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
isPossibleDuplicate boolean check if the transfer could be duplicate, for example, if you retry a failed previous transfer
Response shape
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
BTPlaceSlip2
Method used to place a bet.
Request shape
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
soBetTypesAmount/SOBonus IDFOBetType string Bet type where bonus amount (special offer) is applied
Response shape
BTPlaceSlip2Result/Status StatusCode string Could be open (O), closed (C), attempted (A)
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 IDBTTransaction decimal unique identifier of the process via the terminal
BetSlip PlacementTime dateTime the exact date on which the bet was placed
BetSlip BetSlipExt
BetSlip IsFree boolean Indicates if the bet slip was placed using free bet
ConfirmationRequiredState IsPossibleDuplicate boolean check if the transaction could be duplicate, for example, if you retry a failed previous transfer
ConfirmationRequiredState StatusCode string Could be open (O), closed (C), attempted (A)
BTRejectSlip
Reject an attempted slip when a confirmation is required, for example when a reoffer is received.
Request shape
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
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
Response shape
Returns an object of type BTSessionStatsResponse with the following properties:
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
Response shape
For the response, we will receive an object of type BTTerminalCashboxStatsResult with the following attribute:
BTTerminalDeposit
Method used to make cash deposits.
Request shape
isPossibleDuplicate boolean check if the transfer could be duplicate, for example, if you retry a failed previous transfer
Response shape
CalculateBetSlip
Returns betslip calculations.
Request shape
Response shape
This will give us an array of CalculateBetSlipResult with the following attributes:
GetAllowedBetTypesWithCalculations
Return allowed bet types with potential return calculated for each bet type.
Request shape
Response shape
For the response, we will receive an object of type GetAllowedBetTypesWithCalculationsResult with an array of CalculateBetType objects with following
attributes:
Request
GetAllowedBetTypesWithCalculations
Response
GetAllowedBetTypesWithCalculations Response
GetBookedBetSlip
Return the bet slip associated with the given ID (Bet code)
Request shape
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:
IsFree boolean Indicates if the bet slip was placed using free bet
Example
Request
GetBookedBetSlip Request
Response
GetBookedBetSlip Response
Request shape
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
Response shape
This request returns a list of the Privilege object, which has the following attributes:
Attribute Type Description
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
isPossibleDuplicate boolean check if transfer could be duplicate, for example if you retry a failed previous transfer
Response shape
For the response, we will receive an object of type OPOperatorsTransferResult with the following attributes:
OPPrepareReportString
Generate a report. The response is a fully formatted text string with the report content to be printed as is.
Request shape
Response shape
For the response, we will receive an object of type OPPrepareReportStringResult with the following attribute:
OPPrepareReportStringResult string fully formatted text string with the report content
RegisterTerminal
Register a new terminal in the system.
Request shape
Response shape
Empty object - 200 OK
TerminalLogin
Performs a login action in the system.
Request shape
sPassword string terminal password to authenticate in the system: Password = String .format("j&h%sr[\/", terminalCode)
Response shape
Empty object - 200 OK
Exceptions codes
Code Description Remarks
0080020088 DCUser of terminal is inactive Check DCUser is active in DBCore Admin app
BetSlip DetailedState
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
2 Cancelled Bet has been cancelled TXBETHISTORY_V value = X. No FOBETSTATE value. This is a synthetic value
DisplayBet Entity
BetStatus string Bet Status: Open, Attempted... (Not apply for Bet Code - GetBookedBetSlip)
UnitStakeWin decimal Win part of the bet unit stake, assumed to be unit stake
DisplayBetLeg Entity
PriceDown string Price DOWN used by Bet (depending on the Price Type)
IDFOPriceType string Price type for bet leg AP, BP, FCD,TCD etc.
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.
IsTrap boolean Returns true if Leg is backing 'Runner name' or 'Trap number'. It is always true if bet is within some pool.
MarketBetEnd dateTime Market startting time is actualy market bet end time