 | Feedback |  |
This use case describes how merchants (recipients) can accept fixed recurring payments from their customers using Amazon FPS.
Fast Route (a web site) is a real-time traffic information service that allows users to receive updates on city traffic conditions using their mobile phone. Users can select various subscription plans offered by Fast Route. The subscription plans offered by Fast Route are hourly, daily, and monthly charges. Users are charged depending on the subscription plan they choose.
For demonstration purposes the subscription periods in the sample application is set to hours. However, in a real life use case, Amazon FPS supports subscription period in days, months and years. Also, all subscriptions have a validity of one year.
The user experience illustrates the steps in subscribing and setting up payments for the online magazine subscription.
John visits the Fast Route web site, enters a name, selects the subscription type, and clicks the Register Now button. In this use case, he provides the following information:
Name = John
When John clicks the Register Now button, he is directed to Amazon FPS web site where he views the Amazon.com Sign In page. He signs into his Amazon Payments account using his Amazon.com email address and password.
After John signs onto his Amazon Payments account, he views the Payment Authorization page. This page displays the following information:
John selects his Amazon Payments account balance as the payment method and clicks the Continue button.
After John clicks the Continue button, he views the Confirm Payment Details page. On this page, he can review the payment details and confirm the payment by clicking the Confirm button.
On clicking the Confirm button, John is redirected to the Fast Route web site.
Amazon FPS installs a recurring-use token on John's account.
After John returns to the Fast Route web site, he views the status of his subscription. A thank you page is displayed, which confirms his subscription.
The Fast Route web site will provide John with information and updates on his city's traffic condition on his mobile phone.
Fast Route uses the recurring-use token to charge John depending on his subscription plan.
Fast Route administrators can manage subscription payments from their registered customers using the Administrator link.
The administrator clicks the Administrator link and views the customer records. The customer record contains the customer's name, last payment date, and the due date for the next payment.
For a new customer, these dates are displayed as Not Set.
If the administrators decide to charge John for his next payment, they click the Charge button.
After the administrator clicks the Charge button, Fast Route will make a web service call and transfer money from John's account to the Fast Route's account.
This topic contains information that can help you in building a similar application with the assumption that you are the caller and the recipient. As a caller you can make web service calls to Amazon FPS and as a recipient you can receive payments for the subscription. John is the sender in this use case who uses his Amazon Payment account balance to pay for the subscription. Fast Route is the caller that directs John to the Amazon FPS recurring-use token installation pipeline to install a token that will be used to charge John for his subscription.
See the Acquiring Recurring Payments Tokens section for information on recurring payment tokens.
![[Note]](images/note.png) | Note |
|---|---|
This use case assumes that you are the caller and the recipient (Fast Route). |
Since you play the role of a caller and a recipient, you need a caller token and a recipient token on your account. You can install these tokens on your account using the InstallPaymentInstruction operation. See the Installing Tokens on your Account section for more information on installing tokens on your account. See the Acquiring Recipient Tokenssection for more information on setting up a recipient token on your account.
You will require only one caller token and one recipient token for executing all the payment transactions in this use case and therefore, this is a one-time set up.
In this use case, John plays the role of a sender who registers at the Fast Route web site and uses his Amazon Payment account to subscribe to the real-time traffic information service. You must direct John to the Amazon FPS recurring-use token installation pipeline using a signed URL. A signed URL is created using your caller credentials and other required parameters as explained below.
| Parameter | Value | Description |
|---|---|---|
callerReference | Fast Route - 1169619557608 | A unique reference created to identify the sender token for your future use. |
paymentReason | Payment for real-time traffic information service subscription | Text describing this transaction for your customers. This information is available in the Payment Authorization page. |
recipientTokenId | | This is used to identify the recipient. |
paymentMethod | abt, ba, cc | Payment methods used to make the payment. |
transactionAmount | 20 | The cost of the subscription. |
callerKey | | This is your AWS Access Key Id which is used by Amazon FPS to identify you in the pipeline. |
awsSignature | | Signature of the encoded URL created using your Access Key Id |
pipelineName | Recurring | Name of this pipeline |
returnURL | http://www.fastroute.com/thanks.jsp | The web site URL, where the user is redirected after completing the payment authorization (token installation). |
validityStart | 1169617898 | Validity of the token. |
validityExpiry | 1177393898 | Validity of the token. |
recurringPeriod | 1 week | The frequency at which Fast Route will charge John for the subscription. |
globalAmountLimit | 30 | The maximum amount that can be charged using the recurring payment sender token. |
usageLimitType2 | Amount | You can specify either Amount or Count (number of times) as the usage limit type. |
usageLimitPeriod2 | 1 Week | This takes the value of the following type (examples):
A integer followed by one of the following strings
|
See the Signing A URL section for more information on creating a signed URL.
The co-branded UI pipeline returns the following response parameters:
| Parameter | Value | Description |
|---|---|---|
TokenId | 55X2BQEECJVXLDPDCTVM1QQBJM8ETBMSUS35M7377C17F37CKBB53HII6AV7WXVT | This is John’s sender token that you will use in the Pay call. |
status | SC | Status of the transaction. Since John uses credit card as the payment method to buy the credit instrument, the status is SC. |
You can now use the sender token received from the Amazon FPS recurring-use token installation pipeline along with your caller token and recipient token in the Pay operation to transfer money.
See the Making a Pay Request section for detailed information about using tokens to make a Pay call. Also see Pay operation section for information on the request and response parameters. Parameters and values used in this case are given below:
| Parameter | Value | Description |
|---|---|---|
RecipientTokenId | Your recipient token Id | The token to which the sender will make payments. In this use case this is your token. |
SenderTokenId | Your sender token Id | Specifies the sender token created by John. |
CallerTokenId | Your caller token Id | Your caller token. |
TransactionAmount | 20 | The cost of the subscription. |
TransactionDate | 2007-01-24T06:17:33.929Z | The date on which the transaction is received by Amazon FPS. |
SenderReference | John - 1169619557608 | A unique value used to identify the sender on your web site. |
RecipientReference | FastRoute - 1169619557608 | A unique value used to identify the recipient on your web site. |
CallerReference | FastRoute - 1169619557608 | A unique reference created to identify the sender token for your future reference. |
ChargeFeeTo | Recipient | Specifies that the participant pays the fees to Amazon FPS for the transaction. |
SenderDescription | John - 1169619557608 | Text description about the sender involved in the transaction. |
CallerDescription | FastRoute Online Traffic Information | Text description about the caller in the transaction. |
RecipientDescription | FastRoute Online Traffic Information | Text description about the recipient involved in the transaction. |
MetaData | Payment for the weekly magazine subscription | Used to specify details of the transaction. |
You have to process the response received from Amazon FPS. The response from Amazon FPS contains the status of the transaction and the transactionId. You can store the transactionId for future references. See the Handling Synchronous Responses section for more information.
As a result of the Pay call, money is transferred from sender's account to the recipients account.You can view your account balance from the account management UI. See the Managing Your Account section for more information.
You can use the Amazon FPS APIs to view the transaction details on your account. To view details about a particular transaction, use the GetTransaction. To view the history of all the transactions on your account, use the GetAccountActivity .
