Versions Compared

Key

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

Type definitions

...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleApplicationSubscription

Application subscription details

Field name

Type

Required

Description

subscriptionToken

String

(tick)(tick)

Application key identifier

expiryDateTime

Date

 

Subscription Expiry date

expiredDateTime

Date

 

Subscription Expired date

createdDateTime

Date

 

Subscription Create date

activationDateTime

Date

 

Subscription Activation date

cancellationDateTime

Date

 

Subscription Cancelled date

subscriptionStatus

SubscriptionStatus

 

Subscription status

clientReferenceString Client reference
vendorClientIdString Vendor client Id


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleSubscription History

Application subscription history details

Field name

Type

Required

Description

subscriptionToken

String

(tick)(tick)

Application key identifier

expiryDateTime

Date

 

Subscription Expiry date

expiredDateTime

Date

 

Subscription Expired date

createdDateTime

Date

 

Subscription Create date

activationDateTime

Date

 

Subscription Activation date

cancellationDateTime

Date

 

Subscription Cancelled date

subscriptionStatus

SubscriptionStatus

 

Subscription status

clientReferenceString Client reference


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleAccountSubscription

Application subscription details

Field name

Type

Required

Description

subscriptionTokens

List< SubscriptionTokenInfo >

(tick)(tick)

Lis t of subscription token details

applicationName

String

 

Application name

applicationVersionId

String

 

Application version Id


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleSubscriptionTokenInfo

Subscription token information

Field name

Type

Required

Description

subscriptionToken

String

(tick)(tick)

Subscription token

activatedDateTime

Date

 

Subscription Activated date

expiryDateTime

Date

 

Subscription Expiry date

expiredDateTime

Date

 

Subscription Expired date

cancellationDateTime

Date

 

Subscription Cancelled date

subscriptionStatus

SubscriptionStatus

 

Subscription status


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleDeveloperApp

Describes developer/vendor specific application

Field name

Type

Required

Description

appName

String

(tick)(tick)

The unique name of the application

appId

long

(tick)(tick)

A unique id of this application

appVersions

List< DeveloperAppVersion >

(tick)(tick)

The application versions (including application keys)


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleDeveloperAppVersion

Describes a version of an external application

Field name

Type

Required

Description

owner

String

(tick)(tick)

The user who owns the specific version of the application

versionId

long

(tick)(tick)

The unique Id of the application version

version

String

(tick)(tick)

The version identifier string such as 1.0, 2.0. Unique for a given application.

applicationKey

String

(tick)(tick)

The unqiue application key associated with this application version

delayData

boolean

(tick)(tick)

Indicates whether the data exposed by platform services as seen by this application key is delayed or realtime.

subscriptionRequired

boolean

(tick)(tick)

Indicates whether the application version needs explicit subscription

ownerManaged

boolean

(tick)(tick)

Indicates whether the application version needs explicit management by the software owner. A value of false indicates, this is a version meant for personal developer use.

active

boolean

(tick)(tick)

Indicates whether the application version is currently active

vendorId

String

 

Public unique string provided to the Vendor that they can use to pass to the Betfair API in order to identify themselves.

vendorSecret

String

 

Private unique string provided to the Vendor that they pass with certain calls to confirm their identity. 
Linked to a particular App Key.


...

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.

pointsBalance

int

 

The Betfair points balance.

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


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleVendorAccessTokenInfo

Anchor
vendoraccesstokeninfo
vendoraccesstokeninfo

Wrapper object containing UserVendorSessionToken, RefreshToken and optionally a Subscription Token if one was created

Field name

Type

Required

Description

access_token

String

Session token used by web vendors

token_type

TokenType

TokenType

Anchor
tokenType
tokenType

Type of the token

expires_in

long

How long until the token expires

refresh_token

String

Token used to refresh the session token in future

application_subscription

ApplicationSubscription

Object containing the vendor client id and optionally some subscription information


...