Amazon Flexible Payments Service
Aggregated Payments Guide (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...

Getting Authorization

Before you can issue an Amazon FPS request to charge a buyer for a prepaid payment instrument or set up a postpaid credit instrument, you must get the buyer's authorization. The authorization process uses the Amazon Co-Branded service, which has a different integration method than the Amazon FPS web service. However, The Amazon FPS API requires some of the values that the Co-Branded service returns. When the buyer authorizes a purchase, the Amazon Co-Branded web service creates a payment token, which enables the exchange of money from buyer to seller.

When the buyer (the sender) authorizes the payment for prepaid usage by completing forms within the Co-Branded User Interface (CBUI), the Co-Branded service creates a prepaid payment token, a funding token, and a prepaid payment instrument ID with a zero prepaid balance. You must call the FundPrepaid API to fund the payment instrument, then save the tokens and the instrument ID to use them in Amazon FPS API requests.

When a sender agrees to the terms and conditions for postpaid usage by completing forms within the CBUI, the Co-Branded service returns a postpaid payment token, a settlement token, and a postpaid credit instrument ID with zero accumulated debt. Each time the customer makes purchases, the accumulated debt increases. The debt is paid when you make a call to the SettleDebt API. This always happens when the accumulated debt reaches the maximum, or it can occur at any time the buyer and seller agree, such as at monthly intervals. At any time the AccumulatedDebt is greater than zero, you can reduce or eliminate the accumulated debt with a call to the WriteOffDebt API.

This section describes how to redirect the sender to the prepaid and postpaid Co-Branded user interface. The remainder of this guide describes how to use the Amazon FPS API.

Sending a Co-Branded service Request

This section shows how a buyer (a sender) can authorize the use of a prepaid or postpaid instrument. You obtain authorization for the sender by sending a request to the Co-Branded service. The Co-Branded service request parameters set the usage restrictions for the prepaid or postpaid instrument.

To send a Co-Branded service request to authorize the use of a prepaid token

1

Use the Prepaid Token API along with the parameters common to all Co-Branded service requests to construct a Co-Branded service request similar to the following. For more information, see Prepaid Token API and Common Parameters.

 https://authorize.payments.amazon.com/cobranded-ui/actions/start?
callerKey=[Your AWS Access Key ID]
&callerReferenceFunding=29038fw09548
&callerReferenceSender=SenderName_uniquestring
&FundingAmount=25.00
&pipelineName=SetupPrepaid
&returnURL=http%3A%2F%2Fwww.digitaldownload.com/return
&signature=[URL-encoded value you generate]
&validityExpiry=[One year from today]
&version=2009-01-09

The optional parameters vary in your request according to the terms of the prepaid token.

For more information about getting your AWS Access Key ID value, see the Amazon Flexible Payments Service Getting Started Guide.

2

Calculate the signature and include it.

For more information about creating the value for signature, see Generating a Signature.

3

Create a Pay Now button on your website and attach code to the button that sends the request to purchase the prepaid gift card.


Note

We recommend that you first try your Co-Branded service request in the Amazon FPS Sandbox. For more information, see Testing Your Applications for Free.

To send a Co-Branded service request to authorize the use of a postpaid credit instrument

1

On your web page, set up text to display the value of a prepaid gift card.

2

Use the Postpaid Token API as well as the parameters common to all Co-Branded service requests to construct a Co-Branded service request similar to the following. For more information, see Postpaid Token API and Common Parameters.

https://authorize.payments.amazon.com/cobranded-ui/actions/start?
callerKey=[Your AWS Access Key ID]
&callerReferenceSettlement=234098e097
&callerReferenceSender=SenderName_uniquestring
&globalAmountLimit=100.00
&pipelineName=SetupPostpaid
&returnURL=http%3A%2F%2Fwww.digitaldownload.com/return
&signature=[URL-encoded value you generate]
&version=2009-01-09

The optional parameters vary in your request according to what the recipient offers.

For more information about getting your AWS Access Key ID value, see the Amazon Flexible Payments Service Getting Started Guide.

3

Calculate the signature and include it.

For more information about creating the value for signature, see Generating a Signature.

4

Create an Authorize Now button on your website and implement code attached to that button that sends this request.