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...

GetRecipientVerificationStatus

Description

GetRecipientVerificationStatus enables you to test that the intended recipient has a verified Amazon Payments account before you present the payment option for that seller or recipient on your website. The RecipientVerificationStatus return parameter enables you to determine whether the account is unlimited in the amount of money it can receive.

This action appears in the Advanced and Marketplace Quick Starts.

Request Parameters

ParameterDescriptionRequired

RecipientTokenID

The recipient token returned by the Co-branded user interface.

Type: String

Yes

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

ElementDescription

RecipientVerificationStatus

Status of the verification.

Type: RecipientVerificationStatus

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

Errors are returned only for REST. For SOAP, an error results in a SOAP fault. If the response status is failure, the Errors element includes an error code that identifies the source of the failure. If the response status is success, the elements listed in the preceding table are returned.

Errors

This action can return the following errors:

Examples

Sample REST Request

https://fps.sandbox.amazonaws.com?
Action=GetRecipientVerificationStatus
&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE
&RecipientTokenId=09DG234OGD
&SignatureVersion=2
&SignatureMethod=HmacSHA256
&Timestamp=2008-08-06T13%3A00%3A01Z
&TokenId=254656Example83987
&Version=2008-09-17
&Signature=[URL-encoded signature value]

Sample SOAP Request

<SOAP-ENV:Envelope>
 <SOAP-ENV:Body wsu:Id="body" 
  xmlns:wsu=
    "http://docs.oasis-open.org/wss/2004/01/&#x200b;oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <ns2:GetRecipientVerificationStatus 
   	xmlns:ns2="http://fps.amazonaws.com/doc/2008-09-17/">
      <ns2:RecipientTokenId>
      	M2ABVSN2BH3KRUV9261D59HI2C2TBZDURKFB9MCU88BTHS876ZATXRIHEFZBBKIM
      </ns2:RecipientTokenId>
   </ns2:GetRecipientVerificationStatus>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Sample Response to REST Request

<GetRecipientVerificationResponse xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
  <GetRecipientVerificationResult>
    <RecipientVerificationStatus>
    	VerificationComplete
    </RecipientVerificationStatus>
  </GetRecipientVerificationResult>
  <ResponseMetadata>
    <RequestId>197e2085-1ed7-47a2-93d8-d76b452acc74:0</RequestId>
  </ResponseMetadata>
</GetRecipientVerificationResponse>

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">
      GetRecipientVerificationStatus:Response
    </wsa:Action>
    <wsa:MessageID xmlns:wsa="http://www.w3.org/2005/08/addressing">
      urn:uuid:95f01489-c0de-451d-8f0d-63b44b9c5bd5
    </wsa:MessageID>
  </SOAP-ENV:Header>
  <SOAP-ENV:Body>
    <GetRecipientVerificationStatusResponse
      xmlns="http://fps.amazonaws.com/doc/2008-09-17/">
      <GetRecipientVerificationStatusResult>
        <RecipientVerificationStatus>
          VerificationComplete
        </RecipientVerificationStatus>
      </GetRecipientVerificationStatusResult>
      <ResponseMetadata>
        <RequestId>95f01489-c0de-451d-8f0d-63b44b9c5bd5:0</RequestId>
      </ResponseMetadata>
    </GetRecipientVerificationStatusResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>