Accounts TypeDefinitions
Type definitions
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 |
Application subscription details
Field name | Type | Required | Description |
|---|---|---|---|
subscriptionToken | String |
| 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 |
| Subscription status | |
clientReference | String |
| Client reference |
vendorClientId | String |
| Vendor client Id |
Application subscription history details
Field name | Type | Required | Description |
|---|---|---|---|
subscriptionToken | String |
| 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 |
| Subscription status | |
clientReference | String |
| Client reference |
Application subscription details
Field name | Type | Required | Description |
|---|---|---|---|
subscriptionTokens | List< SubscriptionTokenInfo > |
| Lis t of subscription token details |
applicationName | String |
| Application name |
applicationVersionId | String |
| Application version Id |
Subscription token information
Field name | Type | Required | Description |
|---|---|---|---|
subscriptionToken | String |
| Subscription token |
activatedDateTime | Date |
| Subscription Activated date |
expiryDateTime | Date |
| Subscription Expiry date |
expiredDateTime | Date |
| Subscription Expired date |
cancellationDateTime | Date |
| Subscription Cancelled date |
subscriptionStatus |
| Subscription status |
Describes developer/vendor specific application
Field name | Type | Required | Description |
|---|---|---|---|
appName | String |
| The unique name of the application |
appId | long |
| A unique id of this application |
appVersions | List< DeveloperAppVersion > |
| The application versions (including application keys) |
Describes a version of an external application
Field name | Type | Required | Description |
|---|---|---|---|
owner | String |
| The user who owns the specific version of the application |
versionId | long |
| The unique Id of the application version |
version | String |
| The version identifier string such as 1.0, 2.0. Unique for a given application. |
applicationKey | String |
| The unqiue application key associated with this application version |
delayData | boolean |
| Indicates whether the data exposed by platform services as seen by this application key is delayed or realtime. |
subscriptionRequired | boolean |
| Indicates whether the application version needs explicit subscription |
ownerManaged | boolean |
| 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 |
| 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. |
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/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. |