Amazon Flexible Payments Service
Advanced Quick Start (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...

Recipient Registration

As a caller offering marketplace services, you must provide a way to register recipients so that they can use your services, which include uploading product information for you to display on your website and facilitating the sale of this merchandise. You must collect enough information to identify each recipient so they can get paid for products purchased by buyers. You must handle the upload of product information to your website. Amazon FPS Advanced Quick Start explains how to handle the registration of your recipients and the exchange of money from sender to recipient.

The actions Pay and Reserve, which initiate payment transactions, require parameter values called tokenIDs that identify the sender and the recipient. There is a SenderTokenId parameter, which identifies the sender (who sends the money), and a RecipientTokenId parameter, which identifies the recipient (who receives the money). Because you, the caller, send Pay requests on behalf of the others, you must obtain these tokenID identifiers.

These identifiers are generated by the Amazon Co-Branded service at the request of the Co-Branded User Interface code (CBUI), which is a series of web pages that, among other things, identifies the recipient or sender. This means that your website must have an interface that sends a Co-Branded service request for the sender and a different one for the recipient. The procedures for sending both requests are the same; the only difference is that they use different Co-Branded service APIs. The API used for recipient requests returns a value in tokenID that identifies the recipient, which is used as the value for the RecipientTokenId parameter when making a Pay or Reserve request. The API used for the sender requests returns a tokenID that identifies the sender, which is used as the value for the SenderTokenId parameter.

This section describes how to use the Co-Branded service to register the recipient.

Recipient Registration on Your Website

The following figure represents the first step in the workflow: recipient registration on your website. Merchants must register with you for the following reasons:

  • The recipient must accept your business terms, in particular, the marketplace fee you will charge them.

  • The recipient must be able to upload and otherwise manage the item information to your website.

  • You must have a tokenID value for each recipient, so that you can pay the recipient by using the value for the RecipientTokenId parameter in a Pay or Reserve request.

Recipient Registration

1

Implement a recipient account system on your website.

For example, enable each recipient to sign in to their account with a sign-in name and password.

2As the final stage of your registration process, implement a Register button to send a recipient Co-Branded service request. For more information, see Recipient Token API.
3The recipient enters the required information on the Amazon CBUI pages.
4After confirming his or her choices, the recipient is redirected back to your website with information, such as the recipient's tokenID that you should store in your database.

Implementing the Co-Branded API to Register a Recipient

The Co-Branded API you use for registering a recipient is the Recipient Token API. For more information, see Recipient Token API.

To register a recipient

  1. On your website, enable a recipient to register with you.

    In this step you collect information about the person or company using your services.

  2. Direct each recipient to https://payments.amazon.com/sdui/sdui/premiumaccount to create a business payment account so they can get paid.

  3. On your website, display your business policies, including your marketplace fee structure, and obtain the recipient's acknowledgment.

    Your marketplace fee might include a flat fee, a percentage of the purchase price, or both. You implement your fee structure using the parameters in the Co-Branded service request.

  4. Implement a button that issues a Co-Branded service request that registers the recipient.

    For more information, see Sending a Co-Branded Service Request.

  5. Parse the response.

    In particular, store the tokenID, which is the recipient's. You use this value for the RecipientTokenId in Pay and Reserve requests.