GET api/v1/account/balance

Gets your account balance information

Requires authorization!

Response Codes

  • 200 - Successfully got info of your balance
  • 401 - User is not Authorized

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Gets your account balance information
List of active MyAccountBalance set to Payload property

ApiResultMyAccountBalance
NameDescriptionTypeAdditional information
Payload

The payload of the response. Type depends on the API request.

MyAccountBalance

None.

Success

Indicates if the request was successfull or not. true if the request was handled successfully, false otherwise.

boolean

Required

Errors

Error(s) accociated with the API request.

Collection of ApiError

None.

Response Formats

application/json, text/json

Sample:
{
  "Payload": {
    "Balance": 1.0,
    "Reserved": 2.0,
    "BidRequestAmount": 3.0,
    "TotalAvailable": -4.0
  },
  "Success": true,
  "Errors": [
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    },
    {
      "Code": 1,
      "Message": "sample string-2",
      "Details": "sample string-3"
    }
  ]
}

application/xml, text/xml

Sample:
<ApiResultMyAccountBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Sobralaen.Api.Models">
  <Errors>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
    <ApiError>
      <Code>1</Code>
      <Details>sample string-3</Details>
      <Message>sample string-2</Message>
    </ApiError>
  </Errors>
  <Success>true</Success>
  <Payload>
    <Balance>1</Balance>
    <BidRequestAmount>3</BidRequestAmount>
    <Reserved>2</Reserved>
  </Payload>
</ApiResultMyAccountBalance>