GetTokenByCaller

Description

The GetTokenByCaller action returns the details about the token specified by a tokenId or CallerReference. The CallerReference is the value you passed in the Co-Branded service request, whereas the tokenId is the value you received in the Co-Branded service response.

Request Parameters

Parameter

Description

Parameter	Description	Required
`CallerReference`	A value you provide that uniquely identifies the request. For more information, see Important Values to Store in Your Database. Type: String Default: None Constraint: Max size = 128 characters Condition: Required if `TokenId` is not specified.	Conditional
`TokenId`	The sender token ID that the Co-Branded service returned. Type: String Default: None Constraint: Max size = 65 characters Condition: Required if `CallerReference` is not specified.	Conditional

Required

CallerReference

A value you provide that uniquely identifies the request. For more information, see Important Values to Store in Your Database.

Type: String

Default: None

Constraint: Max size = 128 characters

Condition: Required if TokenId is not specified.

Conditional

TokenId

The sender token ID that the Co-Branded service returned.

Type: String

Default: None

Constraint: Max size = 65 characters

Condition: Required if CallerReference is not specified.

Conditional

For REST requests, you must also include parameters that are common to all requests. These parameters are included by default in SOAP requests. For more information, see Common Request Parameters.

Response Elements

Element Description

Element	Description
`Token`	Details of the specified token. Type: Token

Token

Details of the specified token.

Type: Token

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=GetTokenByCaller
&AWSAccessKeyId=AKIAIUQNNI2DNQHBO7RA
&CallerReference=callerReferenceSingleUse10
&Signature=7E43HRAge3s57KDtEW3%2Fv0CE3Rh4TkVuOpk%2FIU%2FJIEY%3D
&SignatureMethod=HmacSHA256
&SignatureVersion=2
&Timestamp=2009-10-07T11%3A29%3A03.281Z
&TokenId=543IJMECGZZ3J4K1F7BJ3TMNXFBQU9VXNT7RRCTNAJDJ8X36L1ZRKSUUPPIBTTIK
&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:GetTokenByCaller xmlns:ns2="http://fps.amazonaws.com/doc/2008-09-17/">
     <ns2:CallerReference>
      ReferenceString????AxaM12275863261891
     </ns2:CallerReference>
   </ns2:GetTokenByCaller>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response to REST Request

<GetTokenByCallerResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
  <GetTokenByCallerResult>
    <Token>
      <TokenId>
        543IJMECGZZ3J4K1F7BJ3TMNXFBQU9VXNT7RRCTNAJDJ8X36L1ZRKSUUPPIBTTIK
      </TokenId>
      <FriendlyName>Friendly1339359778</FriendlyName>
      <TokenStatus>Active</TokenStatus>
      <DateInstalled>2009-10-07T04:29:05.054-07:00</DateInstalled>
      <CallerReference>callerReferenceSingleUse10</CallerReference>
      <TokenType>SingleUse</TokenType>
      <OldTokenId>
        543IJMECGZZ3J4K1F7BJ3TMNXFBQU9VXNT7RRCTNAJDJ8X36L1ZRKSUUPPIBTTIK
      </OldTokenId>
      <PaymentReason>PaymentReason</PaymentReason>
    </Token>
  </GetTokenByCallerResult>
  <ResponseMetadata>
    <RequestId>45b6c560-8aa9-463c-84be-80eeefb21034:0</RequestId>
  </ResponseMetadata>
</GetTokenByCallerResponse>

Sample Response to SOAP Request

<?xml version="1.0" encoding="UTF-8"?>
<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">
	GetTokenByCaller:Response
	</wsa:Action>
   <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">
	urn:uuid:4802991b-76dd-4f7b-8bd7-a1428cfbb9f2
	</wsa:MessageID>
 </SOAP-ENV:Header>
 <SOAP-ENV:Body>
   <GetTokenByCallerResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
     <GetTokenByCallerResult>
       <Token>
         <TokenId>
          M157V8ZXS4AF9C132FNT5HXNNX8ZK7K1C5IHVRE4VZJTCEBLP8X1CTBCSFTFHKCK
         </TokenId>
         <FriendlyName>
          FriendlyName-pHhq12275863261891
         </FriendlyName>
         <TokenStatus>Active</TokenStatus>
         <DateInstalled>2008-04-24T20:12:06.200-08:00</DateInstalled>
         <CallerReference>ReferenceStringAxaM12275863261891</CallerReference>
         <TokenType>Unrestricted</TokenType>
         <OldTokenId>
          M157V8ZXS4AF9C132FNT5HXNNX8ZK7K1C5IHVRE4VZJTCEBLP8X1CTBCSFTFHKCK
         </OldTokenId>
         <PaymentReason>Testing</PaymentReason>
       </Token>
     </GetTokenByCallerResult>
     <ResponseMetadata>
       <RequestId>4802991b-76dd-4f7b-8bd7-a1428cfbb9f2:0</RequestId>
     </ResponseMetadata>
   </GetTokenByCallerResponse>
 </SOAP-ENV:Body>
</SOAP-ENV:Envelope>