Amazon Simple Pay
Advanced User Guide (API Version 2010-08-28)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

Data Types

This section describes the data types common to the Amazon Simple Pay actions.

Amount Data Types

NameDescription

CurrencyCode

The currency code of the amount. Amazon FPS currently supports only USD.

Type: String

Valid Values: USD

Value

The transaction amount.

Type: String

SubscriptionDetails Type

NameDescriptionType

SubscriptionId

The ID of the subscription

String

Description

The description provided when the subscription was created.

String

SubscriptionAmount

The monetary cost of the subscription

Amount

NextTransactionAmount

The next value to be charged to the subscription

Amount

PromotionalAmount

The amount for the promotion

Amount

NumberOfPromotionalTransactions

How many free editions

Integer

StartDate

When the subscription begins

Date

EndDate

When the subscription ends

Date

SubscriptionPeriod

How long does the subscription last

Duration

SubscriptionFrequency

How often does the subscription happen

Duration

OverrideIPNUrl

Custom IPN target

String

SubscriptionStatus

The status of the subscription

EnumerationStatus

NumberOfTransactionsProcessed

The number of transactions have already passed

Integer

RecipientEmail

Email contact for the subscriber

String

RecipientName

Name of the subscriber

String

SenderEmail

Email contact for the subscription buyer

String

SenderName

Name of the subscription buyer

String

NextTransactionDate

When will the next value be charged to the subscription

Date

SubscriptionTransaction Type

NameDescriptionType

TransactionId

The ID of the transaction

String

TransactionDate

When the transaction occurred

Date

TransactionSerialNumber

Serial number for the transaction.

Integer

TransactionAmount

The monetary cost of the transaction

Amount

Description

The description provided when the subscription was created.

String

Transaction Status

The final status of the transaction

TransactionStatus

MarketplaceRefundPolicy Data Types

NameDescription

MarketplaceTxnOnly

Caller refunds his fee to the recipient.

Type: String

MasterAndMarketplaceTxn

Caller and Amazon FPS refund their fees to the sender, and the recipient refunds his amount

Type: String

MasterTxnOnly

Caller does not refund his fee. Amazon FPS refunds its fee and the recipient refunds his amount plus the caller's fee to the sender.

Type: String

API TransactionStatus Data Types

NameDescriptionType

Cancelled

The transaction was canceled.

String

Failure

The transaction failed. The API operation failed and Amazon FPS did not receive or record a transaction. You can retry the transaction only if a retriable error was returned.

String

Pending

The transaction is pending.

String

Reserved

The reserve request on the transaction succeeded. Amazon FPS reserves the purchase price against the sender's payment instrument.

String

Success

The transaction succeeded. You can fulfill the order for the customer.

String