GetAccountBalance

Description

The GetAccountBalance operation retrieves the amount of money in your Amazon Mechanical Turk account.

Request Parameters

The GetAccountBalance operation accepts parameters common to all operations. Some common parameters are required. See Common Parameters for more information.

The following parameter is specific to the GetAccountBalance operation:

Name Description Required

Name	Description	Required
`Operation`	The name of the operation Type: String Valid Values: GetAccountBalance Default: None	Yes

Operation

The name of the operation

Type: String

Valid Values: GetAccountBalance

Default: None

Yes

Response Elements

A successful request for the GetAccountBalance operation returns with a GetAccountBalanceResult element in the response.

The GetAccountBalanceResult element contains the following elements:

Name	Description
AvailableBalance	The amount available to pay for assignments. This is your current balance minus any outstanding payments, fees or bonuses you owe. Type: Price data structure
OnHoldBalance	Not used. This value is always 0. Type: Price data structure

Name

Description

AvailableBalance

The amount available to pay for assignments. This is your current balance minus any outstanding payments, fees or bonuses you owe.

Type: Price data structure

OnHoldBalance

Not used. This value is always 0.

Type: Price data structure

Examples

The following example shows how to use the GetAccountBalance operation.

Sample Request

The following example retrieves the Requester's account balance.

http://mechanicalturk.amazonaws.com/?Service=AWSMechanicalTurkRequester
&AWSAccessKeyId=[the Requester's Access Key ID]
&Version=2008-08-02
&Operation=GetAccountBalance
&Signature=[signature for this request]
&Timestamp=[your system's local time]

Sample Response

The following is an example response.

<GetAccountBalanceResult>
  <Request>
    <IsValid>True</IsValid>
  </Request>
  <AvailableBalance>
    <Amount>10000.000</Amount>
    <CurrencyCode>USD</CurrencyCode>
    <FormattedPrice>$10,000.00</FormattedPrice>
  </AvailableBalance>
</GetAccountBalanceResult>