Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Type definitions

...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleAccountFundsResponse

Response for retrieving available to bet.

Field name

Type

Required

Description

availableToBetBalance

double


Amount available to bet.

exposure

double


Current exposure.

retainedCommission

double


Sum of retained commission.

exposureLimit

double


Exposure limit.

discountRate

double


User Discount Rate.  Please note:  Betfair AUS customers /NZ customers should not rely on this to determine their discount rates which are now applied at the account level.

pointsBalanceint
The Betfair points balance.  


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleAccountDetailsResponse

Response for Account details.

Field name

Type

Required

Description

currencyCode

String


Default user currency Code. See Currency Parameters for minimum bet sizes relating to each currency.

firstName

String


First Name.

lastName

String


Last Name.

localeCode

String


Locale Code.

region

String


Region based on users zip/postcode (ISO 3166-1 alpha-3 format). Defaults to GBR if zip/postcode cannot be identified.

timezone

String


User Time Zone.

discountRate

double


User Discount Rate.   Please note:  Betfair AUS customers /NZ customers should not rely on this to determine their discount rates which are now applied at the account level.

pointsBalance

int


The Betfair points balance.

countryCodeString
The customer's country of residence (ISO 2 Char format)


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleStatementLegacyData

Summary of a cleared order.

Field name

Type

Required

Description

avgPrice

double


The average matched price of the bet (null if no part has been matched)

betSize

double


The amount of the stake of your bet. (0 for commission payments or deposit/withdrawals)

betType

String


Back or lay

betCategoryType

String


Exchange, Market on Close SP bet, or Limit on Close SP bet.

commissionRate

String


Commission rate on market

eventId

long


Please note: this is the Id of the market without the associated exchangeId

eventTypeId

long


Event Type

fullMarketName

String


Full Market Name. For card payment items, this field contains the card name

grossBetAmount

double


The winning amount to which commission is applied.

marketName

String


Market Name. For card transactions, this field indicates the type of card transaction (deposit, deposit fee, or withdrawal).

marketType

marketType


Market type. For account deposits and withdrawals, marketType is set to NOT_APPLICABLE.

placedDate

Date


Date and time of bet placement

selectionId

long


Id of the selection (this will be the same for the same selection across markets)

selectionName

String


Name of the selection

startDate

Date


Date and time at the bet portion was settled

transactionType

String


Debit or credit

transactionId

long


The unique reference Id assigned to account deposit and withdrawals.

winLose

winLose


Win or loss

deadHeatPriceDivisordouble

In the instance of a dead heat, this field will indicate the number of winners involved in the dead heat (null otherwise)

avgPriceRawdouble
Currently returns same value as avgPrice. Once released will display the average matched price of the bet with no rounding applied


...