Amazon Flexible Payments Service
API Reference (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...

GetTokens

Description

The GetTokens action returns all or a subset of the tokens that you installed on your account.

This action appears in the Account Management Quick Start.

Request Parameters

ParameterDescriptionRequired

CallerReference

A value you provide that uniquely identifies the request.

Type: String

Default: None

Constraint: Max size = 128 characters

No

TokenStatus

Filters the results based on the status of the token.

Type: TokenStatus

Default: None

No

TokenType

Filters the result based on the token type.

Type: TokenType

Default: None

No

You must also use parameters that are common to all requests that 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

ElementDescription

Token

The list of the caller's tokens.

Type: Token

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=GetTokens
&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE
&CallerReference=CallerReference12
&Signature=Dzp4usKpQujx9x74WFxl5BO2C3ID65PlEb2MXwkyV8M%3D
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2009-10-07T11%3A38%3A11.796Z
&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:GetTokens
      xmlns:ns2="http://fps.amazonaws.com/doc/2008-09-17/">
      <ns2:CallerReference>293847SKDJRH29387</ns2:CallerReference>
    </ns2:GetTokens>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response to REST Request

<GetTokensResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
 <GetTokensResult>
  <Token>
   <TokenId>
    D439DTSTMP4FK9NBL6PEKZWAPGRDZ2BDX3MJNGVX37EF3GA7XRQHMEELQOGFZ9GK
   </TokenId>
   <TokenStatus>Active</TokenStatus>
   <DateInstalled>2009-10-07T04:37:57.375-07:00</DateInstalled>
   <CallerReference>CallerReference12</CallerReference>
   <TokenType>SingleUse</TokenType>
   <OldTokenId>
    D439DTSTMP4FK9NBL6PEKZWAPGRDZ2BDX3MJNGVX37EF3GA7XRQHMEELQOGFZ9GK
   </OldTokenId>
  </Token>
 </GetTokensResult>
 <ResponseMetadata>
  <RequestId>c9db3c80-ff03-4a32-b6b6-ee071cd118c8:0</RequestId>
 </ResponseMetadata>
</GetTokensResponse>

Sample Response to SOAP Request

This section shows a sample SOAP response.

<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">
			GetTokens:Response
		</wsa:Action>
		<wsa:MessageID 
			xmlns:wsa="http://www.w3.org/2005/08/addressing">
			urn:uuid:edf2a735-2b50-4c71-9a1a-943d946d4a89
		</wsa:MessageID>
	</SOAP-ENV:Header>
	<SOAP-ENV:Body>
		<GetTokensResponse 
			xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
			<GetTokensResult>
				<Token>
					<TokenId>
            M157V8ZXS4AF9C132FNT5HXNNX8ZK7K1C5IHVRE4VZJTCEBLP8X1CTBCSFTFHKCK
          </TokenId>
						<FriendlyName>FriendlyName-????pHhq12275863261891</
							FriendlyName>
							<TokenStatus>Active</TokenStatus>
							<DateInstalled>2008-04-24T20:12:06.200-08:00</DateInstalled>
							<CallerReference>293847SKDJRH29387</CallerReference>
							<TokenType>Unrestricted</TokenType>
							<OldTokenId>
              M157V8ZXS4AF9C132FNT5HXNNX8ZK7K1C5IHVRE4VZJTCEBLP8X1CTBCSFTFHKCK
              </OldTokenId>
							<PaymentReason>Testing</PaymentReason>
				</Token>
			</GetTokensResult>
			<ResponseMetadata>
				<RequestId>edf2a735-2b50-4c71-9a1a-943d946d4a89:0</RequestId>
			</ResponseMetadata>
		</GetTokensResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Related Actions