| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
GetAccountBalance
Description
The GetAccountBalance action returns the current balance of your
account.
This action appears in the Account Management Quick Start.
Request Parameters
This action requires only the parameters that are common to all requests. They are described in Common Request Parameters. The common parameters are defaulted in SOAP calls but must be explicitly added in REST calls. Parameter names are case sensitive.
Response Elements
| Element | Description |
|---|---|
|
|
Specifies the current balance. Type: String |
Responses also include elements common to all responses. For more information, see Common Response Elements.
Errors
This action can return the following errors:
Examples
The following sections show a sample request and response.
Sample REST Request
https://fps.sandbox.amazonaws.com? Action=GetAccountBalance &AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE &Signature=FyQVfGnvleChBRKrWY9XpyXTDfQ09oSdlnGBKw4527Y%3D &SignatureMethod=HmacSHA256 &SignatureVersion=2 &Timestamp=2009-10-07T11%3A15%3A46.546Z &Version=2008-09-17
Sample SOAP Request
<SOAP-ENV:Envelope>
<SOAP-ENV:Body wsu:Id="body"
xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
<ns2:GetAccountBalance
xmlns:ns2="http://fps.amazonaws.com/doc/2008-09-17/"/>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>Sample Response to REST Request
<GetAccountBalanceResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
<GetAccountBalanceResult>
<AccountBalance>
<TotalBalance>
<CurrencyCode>USD</CurrencyCode>
<Value>7.400000</Value>
</TotalBalance>
<PendingInBalance>
<CurrencyCode>USD</CurrencyCode>
<Value>0.000000</Value>
</PendingInBalance>
<PendingOutBalance>
<CurrencyCode>USD</CurrencyCode>
<Value>0.000000</Value>
</PendingOutBalance>
<AvailableBalances>
<DisburseBalance>
<CurrencyCode>USD</CurrencyCode>
<Value>7.400000</Value>
</DisburseBalance>
<RefundBalance>
<CurrencyCode>USD</CurrencyCode>
<Value>7.400000</Value>
</RefundBalance>
</AvailableBalances>
</AccountBalance>
</GetAccountBalanceResult>
<ResponseMetadata>
<RequestId>7b74a504-7517-4d81-8312-1427570d028c:0</RequestId>
</ResponseMetadata>
</GetAccountBalanceResponse>
Sample Response to SOAP Request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header> <wsa:RelatesTo xmlns:wsa="http://www.w3.org/2005/08/addressing"> MESSAGE123 </wsa:RelatesTo> <wsa:To xmlns:wsa="http://www.w3.org/2005/08/addressing"> http://www.w3.org/2005/08/addressing/anonymous </wsa:To> <wsa:Action xmlns:wsa="http://www.w3.org/2005/08/addressing"> GetAccountBalance:Response </wsa:Action> <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing"> urn:uuid:fce1f1e5-de4e-401b-b0bb-905e84ee933b </wsa:MessageID> </SOAP-ENV:Header> <SOAP-ENV:Body> <GetAccountBalanceResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/"> <GetAccountBalanceResult> <AccountBalance> <TotalBalance> <CurrencyCode>USD</CurrencyCode> <Value>10.750000</Value> </TotalBalance> <PendingInBalance> <CurrencyCode>USD</CurrencyCode> <Value>0.000000</Value> </PendingInBalance> <PendingOutBalance> <CurrencyCode>USD</CurrencyCode> <Value>0.000000</Value> </PendingOutBalance> <AvailableBalances> <DisburseBalance> <CurrencyCode>USD</CurrencyCode> <Value>10.750000</Value> </DisburseBalance> <RefundBalance> <CurrencyCode>USD</CurrencyCode> <Value>10.750000</Value> </RefundBalance> </AvailableBalances> </AccountBalance> </GetAccountBalanceResult> <ResponseMetadata> <RequestId>fce1f1e5-de4e-401b-b0bb-905e84ee933b:0</RequestId> </ResponseMetadata> </GetAccountBalanceResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope>
