POST Client/GetClientBalances

Gets the client's balances.

Request Information

URI Parameters

None.

Body Parameters

ApiClientBalancesRequestFilter
NameDescriptionTypeAdditional information
clientID

Gets or sets the client identifier.

 integer

None.
includeBonus

Include bonus balance in response object.

 boolean

None.
userID

Gets or sets the user identifier.

 integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "clientID": 1,
  "includeBonus": true,
  "userID": 2
}

application/xml, text/xml

Sample: 
<ApiClientBalancesRequestFilter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <userID>2</userID>
  <clientID>1</clientID>
  <includeBonus>true</includeBonus>
</ApiClientBalancesRequestFilter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiClientBalanceResponse
NameDescriptionTypeAdditional information
ResponseObject

Gets or sets the response object.

 ApiClientBalance

None.
ResponseType

Gets or sets the type of the response.

 integer

None.
ResponseMessage

Gets or sets the response message.

 string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseObject": {
    "BalanceAvailable": 1.0,
    "BalancePending": 2.0,
    "BonusBalance": 1.0
  },
  "ResponseType": 1,
  "ResponseMessage": "sample string 2"
}

application/xml, text/xml

Sample: 
<ApiClientBalanceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SyX.Online.API.Models">
  <ResponseMessage>sample string 2</ResponseMessage>
  <ResponseType>1</ResponseType>
  <ResponseObject>
    <BalanceAvailable>1</BalanceAvailable>
    <BalancePending>2</BalancePending>
    <BonusBalance>1</BonusBalance>
  </ResponseObject>
</ApiClientBalanceResponse>