Versions Compared

Key

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

...

...

Type definitions


Anchor
Transfer
Transfer

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleTransferResponse

Transfer operation response

Field name

Type

Required

Description

transactionId

String

The id of the transfer transaction that will be used in tracking the transfers between the wallets

...

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
titleCurrencyRate

 Currency rate

Field name

Type

Required

Description

currencyCode

String

 

Three letter ISO 4217 code

rate

double

 

Exchange rate for the currency specified in the request

Panel
bgColor#FFFFFF
titleColor#FFCC33
titleSubscriptionOptions

SubscriptionOptions

Anchor
subscriptionoptions
subscriptionoptions

Wrapper object containing details of how a subscription should be created

Field name

Type

Required

Description

subscription_length

int

 

How many days should a created subscription last for. Open ended subscription created if value not provided. 
Relevant only if createdSubscription is true.

subscription_token

String

 

An existing subscription token that the caller wishes to be activated instead of creating a new one. 
Ignored is createSubscription is true.

client_reference

String

 

Any client reference for this subscription token request.

Panel
titleVendorAccessTokenInfo

VendorAccessTokenInfo

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

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

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleVendorDetails

VendorDetails

Anchor
vendordetails
vendordetails

Wrapper object containing vendor name and redirect url

Field name

Type

Required

Description

appVersionId

long

Internal id of the application

vendorName

String

Vendor name

redirectUrl

String

 

URL to be redirected to

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleAuthorisationResponse

AuthorisationResponse

Anchor
authorisationresponse
authorisationresponse

Wrapper object containing authorisation code and redirect URL for web vendors

Field name

Type

Required

Description

authorisationCode

String

The authorisation code

redirectUrl

String

URL to redirect the user to the vendor page