Amazon Flexible Payments Service
Aggregated Payments Guide (API Version 2010-08-28)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Did this page help you?  Yes | No |  Tell us about it...

GetTotalPrepaidLiability

Description

The GetTotalPrepaidLiability action returns the recipient's total liability resulting from all of his or her prepaid instruments.

Request Parameters

GetTotalPrepaidLiability only uses parameters that are common to all requests (for a list, see Common Request Parameters). Amazon FPS uses your AWSAccessKeyId to retrieve the correct results.

Response Elements

ElementDescription

OutstandingPrepaidLiability

Specifies the sum of all the balances of all the prepaid instruments where you hold the prepaid liability.

Type: OutstandingPrepaidLiability

Responses also include elements common to all responses. For more information, see Common Response Elements.

Examples

The following sections show a sample request and response.

Sample REST Request

https://fps.sandbox.amazonaws.com?
Action=GetTotalPrepaidLiability
&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE
&Signature=O%2FVVBU%2FzHk7Rp%2FSjFsE932PGpaJU777klujOjx%2FxL8I%3D
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2009-10-07T11%3A40%3A12.109Z
&Version=2008-09-17

Sample SOAP Request

<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:GetTotalPrepaidLiability 
    xmlns:ns2="http://fps.amazonaws.com/doc/2008-09-17/"/>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response to REST Request

<GetTotalPrepaidLiabilityResponse 
  xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
  <GetTotalPrepaidLiabilityResult>
    <OutstandingPrepaidLiability>
      <OutstandingBalance>
        <CurrencyCode>USD</CurrencyCode>
        <Value>2.000000</Value>
      </OutstandingBalance>
      <PendingInBalance>
        <CurrencyCode>USD</CurrencyCode>
        <Value>0.000000</Value>
      </PendingInBalance>
    </OutstandingPrepaidLiability>
  </GetTotalPrepaidLiabilityResult>
  <ResponseMetadata>
    <RequestId>ac7b28ea-c340-4638-be46-d4a8fa54a801:0</RequestId>
  </ResponseMetadata>
</GetTotalPrepaidLiabilityResponse>

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">
    GetTotalPrepaidLiability:Response
   </wsa:Action>
   <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">
    urn:uuid:16d69143-2542-4b8f-8642-8d96d8a3a8fb
   </wsa:MessageID>
 </SOAP-ENV:Header>
 <SOAP-ENV:Body>
   <GetTotalPrepaidLiabilityResponse 
   xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
     <GetTotalPrepaidLiabilityResult>
       <OutstandingPrepaidLiability>
         <OutstandingBalance>
           <CurrencyCode>USD</CurrencyCode>
           <Value>50.000000</Value>
         </OutstandingBalance>
         <PendingInBalance>
           <CurrencyCode>USD</CurrencyCode>
           <Value>0.000000</Value>
         </PendingInBalance>
       </OutstandingPrepaidLiability>
     </GetTotalPrepaidLiabilityResult>
     <ResponseMetadata>
       <RequestId>16d69143-2542-4b8f-8642-8d96d8a3a8fb:0</RequestId>
     </ResponseMetadata>
   </GetTotalPrepaidLiabilityResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>