Amazon Flexible Payments System Migration Guide
The 2008-09-17 version of the Amazon Flexible Payments Service (FPS) represents a major reorganization of this product. This guide summarizes the changes and shows you how to map previous functionality to current functionality.
Amazon FPS is now presented in the following five packages:
- Amazon FPS Basic Quick Start
- Amazon FPS Advanced Quick Start
- Amazon FPS Marketplace Quick Start
- Amazon FPS Aggregated Payments Quick Start
- Amazon FPS Account Management Quick Start
- You no longer need to create a caller ID for a token
- You no longer need to install payment tokens, unless you create custom tokens with the GateKeeper language
- GetTransactionStatus has been added to the API
- The following actions have been replaced by IPN notifications: GetResults, DiscardResults, SubscribeForCallerNotification, UnsubscribeForCallerNotification. The following table shows workarounds.
Old Action Use Instead GetResults GetTransactionStatus DiscardResults Subscribe to Instant Payments Notification (IPN) on payments.amazon.com SubscribeForCallerNotification Unsubscribe to Instant Payments Notification UnsubscribeForCallerNotification (IPN) on payments.amazon.com
The following table shows the APIs in each Amazon FPS package.
Operation Name |
Parameters and Elements |
Request \ Response |
BAS |
MKT |
ADV |
AGG |
ACT MGT |
|---|---|---|---|---|---|---|---|
| Cancel | TransactionId | Request | Y | Y | N | N | N |
| Cancel | Description | Request | Y | Y | N | N | N |
| Cancel | Metadata | Request | N | N | N | N | N |
| Cancel | TransactionResponse | Response | N | N | N | N | N |
| Cancel | TransactionStatus | Response | Y | Y | N | N | N |
| Cancel | TransactionId | Response | Y | Y | N | N | N |
| Cancel | Status | Response | N | N | N | N | N |
| Cancel | Errors | Response | N | N | N | N | N |
| Cancel | RequestId | Response | Y | Y | N | N | N |
| CancelToken | All | Request | N | N | Y | Y | N |
| CancelToken | All (Except Status & Errors) | Response | N | N | Y | Y | N |
| DiscardResults | All | Request | N | N | N | N | N |
| DiscardResults | All (Except Status & Errors) | Response | N | N | N | N | N |
| FundPrepaid | PrepaidInstrumentId | Request | N | N | N | Y | N |
| FundPrepaid | SenderTokenId | Request | N | N | N | Y | N |
| FundPrepaid | CallerTokenId | Request | N | N | N | N | N |
| FundPrepaid | FundingAmount | Request | N | N | N | Y | N |
| FundPrepaid | TransactionDate | Request | N | N | N | N | N |
| FundPrepaid | CallerReference | Request | N | N | N | Y | N |
| FundPrepaid | SenderReference | Request | N | N | N | N | N |
| FundPrepaid | RecipientReference | Request | N | N | N | N | N |
| FundPrepaid | CallerDescription | Request | N | N | N | Y | N |
| FundPrepaid | SenderDescription | Request | N | N | N | Y | N |
| FundPrepaid | RecipientDescription | Request | N | N | N | N | N |
| FundPrepaid | Metadata | Request | N | N | N | N | N |
| FundPrepaid | DescriptorPolicy | Request | N | N | N | Y | N |
| FundPrepaid | TransactionResponse | Response | N | N | N | N | N |
| FundPrepaid | TransactionStatus | Response | N | N | N | Y | N |
| FundPrepaid | TransactionId | Response | N | N | N | Y | N |
| FundPrepaid | Status | Response | N | N | N | N | N |
| FundPrepaid | Errors | Response | N | N | N | N | N |
| FundPrepaid | RequestId | Response | N | N | N | Y | N |
| GetAccountActivity | All | Request | N | N | N | N | Y |
| GetAccountActivity | All (Except Status & Errors) | Response | N | N | N | N | Y |
| GetAccountBalance | All | Request | N | N | N | N | Y |
| GetAccountBalance | All (Except Status & Errors) | Response | N | N | N | N | Y |
| GetAllCreditInstruments | All | Request | N | N | N | N | N |
| GetAllCreditInstruments | All (Except Status & Errors) | Response | N | N | N | N | N |
| GetAllPrepaidInstruments | All | Request | N | N | N | N | N |
| GetAllPrepaidInstruments | All (Except Status & Errors) | Response | N | N | N | N | N |
| GetDebtBalance | All | Request | N | N | N | Y | N |
| GetDebtBalance | All (Except Status & Errors) | Response | N | N | N | Y | N |
| GetOutstandingDebtBalance | All | Request | N | N | N | Y | N |
| GetOutstandingDebtBalance | All (Except Status & Errors) | Response | N | N | N | Y | N |
| GetPaymentInstruction | All | Request | N | N | N | N | N |
| GetPaymentInstruction | All (Except Status & Errors) | Response | N | N | N | N | N |
| GetPrepaidBalance | All | Request | N | N | N | Y | N |
| GetPrepaidBalance | All (Except Status & Errors) | Response | N | N | N | Y | N |
| GetResults | All | Request | N | N | N | N | N |
| GetResults | All (Except Status & Errors) | Response | N | N | N | N | N |
| GetTokenByCaller | All | Request | Y | Y | Y | Y | N |
| GetTokenByCaller | All (Except Status & Errors) | Response | Y | Y | Y | Y | N |
| GetTokens | TokenFriendlyName | Request | N | N | N | N | N |
| GetTokens | TokenStatus | Request | N | N | N | N | Y |
| GetTokens | CallerReference | Request | N | N | N | N | Y |
| GetTokens | All (Except Status & Errors) | Response | N | N | N | N | Y |
| GetTokenUsage | All | Request | N | N | N | N | Y |
| GetTokenUsage | All (Except Status & Errors) | Response | N | N | N | N | Y |
| GetTotalPrepaidLiability | All | Request | N | N | N | Y | N |
| GetTotalPrepaidLiability | All (Except Status & Errors) | Response | N | N | N | Y | N |
| GetTransaction | TransactionId | Request | N | N | N | N | Y |
| GetTransaction | TrDet.TransactionId | Response | N | N | N | N | Y |
| GetTransaction | TrDet.CallerTransactionDate | Response | N | N | N | N | N |
| GetTransaction | TrDet.DateReceived | Response | N | N | N | N | Y |
| GetTransaction | TrDet.DateCompleted | Response | N | N | N | N | Y |
| GetTransaction | TrDet.TransactionAmount | Response | N | N | N | N | Y |
| GetTransaction | TrDet.FPSFees | Response | N | N | N | N | Y |
| GetTransaction | TrDet.MarketPlaceFee | Response | N | N | N | N | Y |
| GetTransaction | TrDet.FPSFeePaidBy | Response | N | N | N | N | Y |
| GetTransaction | TrDet.CallerTokenId | Response | N | N | N | N | N |
| GetTransaction | TrDet.SenderTokenId | Response | N | N | N | N | Y |
| GetTransaction | TrDet.RecipientTokenId | Response | N | N | N | N | Y |
| GetTransaction | TrDet.PrepaidInstrumentId | Response | N | N | N | N | Y |
| GetTransaction | TrDet.CreditInstrumentId | Response | N | N | N | N | Y |
| GetTransaction | TrDet.Operation | Response | N | N | N | N | Y |
| GetTransaction | TrDet.PaymentMethod | Response | N | N | N | N | Y |
| GetTransaction | TrDet.Status | Response | N | N | N | N | Y |
| GetTransaction | TrDet.ErrorCode | Response | N | N | N | N | Y |
| GetTransaction | TrDet.ErrorMessage | Response | N | N | N | N | Y |
| GetTransaction | TrDet.MetaData | Response | N | N | N | N | Y |
| GetTransaction | TrDet.CallerName | Response | N | N | N | N | Y |
| GetTransaction | TrDet.RecipientName | Response | N | N | N | N | Y |
| GetTransaction | TrDet.SenderName | Response | N | N | N | N | Y |
| GetTransaction | TrDet.TransactionParts | Response | N | N | N | N | N |
| GetTransaction | TrDet.StatusHistory | Response | N | N | N | N | Y |
| GetTransaction | TrDet.RelatedTransactions | Response | N | N | N | N | Y |
| GetTransaction | TrDet.SenderEmailAddress | Response | Y | N | N | N | N |
| GetTransaction | TrDet.RecipientEmailAddress | Response | N | Y | N | N | N |
| GetTransaction | Status | Response | N | N | N | N | N |
| GetTransaction | Errors | Response | N | N | N | N | N |
| GetTransaction | RequestId | Response | N | N | N | N | Y |
| GetTransactionStatus | TransactionId | Request | Y | Y | Y | Y | N |
| GetTransactionStatus | TransactionStatus | Response | Y | Y | Y | Y | N |
| GetTransactionStatus | TransactionId | Response | Y | Y | Y | Y | N |
| GetTransactionStatus | CallerReference | Response | Y | Y | Y | Y | N |
| GetTransactionStatus | PendingReason | Response | Y | Y | Y | Y | N |
| GetTransactionStatus | FailureReason | Response | Y | Y | Y | Y | N |
| GetTransactionStatus | RequestId | Response | Y | Y | Y | Y | N |
| InstallPaymentInstruction | All | Request | N | N | N | N | N |
| InstallPaymentInstruction | All (Except Status & Errors) | Response | N | N | N | N | N |
| Pay | RecipientTokenId | Request | N | Y | Y | N | N |
| Pay | SenderTokenId | Request | Y | Y | Y | Y | N |
| Pay | CallerTokenId | Request | N | N | N | N | N |
| Pay | TransactionAmount | Request | Y | Y | Y | Y | N |
| Pay | ChargeFeeTo | Request | N | Y | Y | Y | N |
| Pay | TransactionDate | Request | N | N | N | N | N |
| Pay | CallerReference | Request | Y | Y | Y | Y | N |
| Pay | SenderReference | Request | N | N | N | N | N |
| Pay | RecipientReference | Request | N | N | N | N | N |
| Pay | CallerDescription | Request | Y | Y | Y | Y | N |
| Pay | SenderDescription | Request | Y | Y | Y | N | N |
| Pay | RecipientDescription | Request | N | N | N | N | N |
| Pay | Metadata | Request | N | N | N | N | N |
| Pay | MarketplaceFixedFee | Request | N | Y | Y | N | N |
| Pay | MarketplaceVariableFee | Request | N | Y | Y | N | N |
| Pay | QuasiCashTransaction | Request | Y | N | N | N | N |
| Pay | DescriptorPolicy | Request | Y | Y | Y | N | N |
| Pay | FirstOrderDate | Request | N | N | N | N | N |
| Pay | ShippingDetails | Request | N | N | N | N | N |
| Pay | DecisionStrategy | Request | N | N | N | N | N |
| Pay | TransactionResponse | Response | N | N | N | N | N |
| Pay | TransactionStatus | Response | Y | Y | Y | Y | N |
| Pay | TransactionId | Response | Y | Y | Y | Y | N |
| Pay | NewSenderTokenUsage | Response | N | N | N | N | N |
| Pay | Status | Response | N | N | N | N | N |
| Pay | Errors | Response | N | N | N | N | N |
| Pay | RequestId | Response | Y | Y | Y | Y | N |
| Refund | CallerTokenId | Request | N | N | N | N | N |
| Refund | RefundSenderTokenId | Request | N | N | N | N | N |
| Refund | TransactionId | Request | Y | Y | Y | Y | N |
| Refund | RefundAmount | Request | Y | Y | Y | Y | N |
| Refund | ChargeFeeTo | Request | N | N | N | N | N |
| Refund | TransactionDate | Request | N | N | N | N | N |
| Refund | CallerReference | Request | Y | Y | Y | Y | N |
| Refund | RefundSenderReference | Request | N | N | N | N | N |
| Refund | RefundRecipientReference | Request | N | N | N | N | N |
| Refund | CallerDescription | Request | Y | Y | Y | Y | N |
| Refund | RefundSenderDescription | Request | N | N | N | N | N |
| Refund | RefundRecipientDescription | Request | N | N | N | N | N |
| Refund | Metadata | Request | N | N | N | N | N |
| Refund | MarketplaceRefundPolicy | Request | N | Y | Y | Y | N |
| Refund | TransactionResponse | Response | N | N | N | N | N |
| Refund | TransactionStatus | Response | Y | Y | Y | Y | N |
| Refund | TransactionId | Response | Y | Y | Y | Y | N |
| Refund | Status | Response | N | N | N | N | N |
| Refund | Errors | Response | N | N | N | N | N |
| Refund | RequestId | Response | Y | Y | Y | Y | N |
| Reserve | RecipientTokenId | Request | N | Y | N | N | N |
| Reserve | SenderTokenId | Request | Y | Y | N | N | N |
| Reserve | CallerTokenId | Request | N | N | N | N | N |
| Reserve | TransactionAmount | Request | Y | Y | N | N | N |
| Reserve | ChargeFeeTo | Request | N | Y | N | N | N |
| Reserve | ReserveUpto | Request | N | N | N | N | N |
| Reserve | ReserveExpiryTimeInHours | Request | N | N | N | N | N |
| Reserve | TransactionDate | Request | N | N | N | N | N |
| Reserve | CallerReference | Request | Y | Y | N | N | N |
| Reserve | SenderReference | Request | N | N | N | N | N |
| Reserve | RecipientReference | Request | N | N | N | N | N |
| Reserve | CallerDescription | Request | Y | Y | N | N | N |
| Reserve | SenderDescription | Request | Y | Y | N | N | N |
| Reserve | RecipientDescription | Request | N | N | N | N | N |
| Reserve | Metadata | Request | N | N | N | N | N |
| Reserve | MarketplaceFixedFee | Request | N | Y | N | N | N |
| Reserve | MarketplaceVariableFee | Request | N | Y | N | N | N |
| Reserve | QuasiCashTransaction | Request | Y | N | N | N | N |
| Reserve | DescriptorPolicy | Request | Y | Y | N | N | N |
| Reserve | FirstOrderDate | Request | N | N | N | N | N |
| Reserve | ShippingDetails | Request | N | N | N | N | N |
| Reserve | DecisionStrategy | Request | N | N | N | N | N |
| Reserve | TransactionResponse | Response | N | N | N | N | N |
| Reserve | TransactionStatus | Response | Y | Y | N | N | N |
| Reserve | TransactionId | Response | Y | Y | N | N | N |
| Reserve | Status | Response | N | N | N | N | N |
| Reserve | Errors | Response | N | N | N | N | N |
| Reserve | RequestId | Response | Y | Y | N | N | N |
| RetryTransaction | All | Request | N | N | N | N | N |
| RetryTransaction | All (Except Status & Errors) | Response | N | N | N | N | N |
| Settle | ReserveTransactionId | Request | Y | Y | N | N | N |
| Settle | TransactionAmount | Request | Y | Y | N | N | N |
| Settle | TransactionDate | Request | N | N | N | N | N |
| Settle | TransactionResponse | Response | N | N | N | N | N |
| Settle | TransactionStatus | Response | Y | Y | N | N | N |
| Settle | TransactionId | Response | Y | Y | N | N | N |
| Settle | Status | Response | N | N | N | N | N |
| Settle | Errors | Response | N | N | N | N | N |
| Settle | RequestId | Response | Y | Y | N | N | N |
| SettleDebt | CreditInstrumentId | Request | N | N | N | Y | N |
| SettleDebt | SenderTokenId | Request | N | N | N | Y | N |
| SettleDebt | CallerTokenId | Request | N | N | N | N | N |
| SettleDebt | SettlementAmount | Request | N | N | N | Y | N |
| SettleDebt | TransactionDate | Request | N | N | N | N | N |
| SettleDebt | CallerReference | Request | N | N | N | Y | N |
| SettleDebt | SenderReference | Request | N | N | N | N | N |
| SettleDebt | RecipientReference | Request | N | N | N | N | N |
| SettleDebt | CallerDescription | Request | N | N | N | Y | N |
| SettleDebt | SenderDescription | Request | N | N | N | Y | N |
| SettleDebt | RecipientDescription | Request | N | N | N | N | N |
| SettleDebt | Metadata | Request | N | N | N | N | N |
| SettleDebt | DescriptorPolicy | Request | N | N | N | N | N |
| SettleDebt | TransactionResponse | Response | N | N | N | N | N |
| SettleDebt | TransactionStatus | Response | N | N | N | Y | N |
| SettleDebt | TransactionId | Response | N | N | N | Y | N |
| SettleDebt | Status | Response | N | N | N | N | N |
| SettleDebt | Errors | Response | N | N | N | N | N |
| SettleDebt | RequestId | Response | N | N | N | Y | N |
| SubscribeForCallerNotification | All | Request | N | N | N | N | N |
| SubscribeForCallerNotification | All (Except Status & Errors) | Response | N | N | N | N | N |
| UnsubscribeForCallerNotification | All | Request | N | N | N | N | N |
| UnsubscribeForCallerNotification | All (Except Status & Errors) | Response | N | N | N | N | N |
| WriteOffDebt | CreditInstrumentId | Request | N | N | N | Y | N |
| WriteOffDebt | CallerTokenId | Request | N | N | N | N | N |
| WriteOffDebt | AdjustmentAmount | Request | N | N | N | Y | N |
| WriteOffDebt | TransactionDate | Request | N | N | N | N | N |
| WriteOffDebt | CallerReference | Request | N | N | N | Y | N |
| WriteOffDebt | SenderReference | Request | N | N | N | N | N |
| WriteOffDebt | RecipientReference | Request | N | N | N | N | N |
| WriteOffDebt | CallerDescription | Request | N | N | N | Y | N |
| WriteOffDebt | SenderDescription | Request | N | N | N | N | N |
| WriteOffDebt | RecipientDescription | Request | N | N | N | N | N |
| WriteOffDebt | Metadata | Request | N | N | N | N | N |
| WriteOffDebt | TransactionResponse | Response | N | N | N | N | N |
| WriteOffDebt | TransactionStatus | Response | N | N | N | Y | N |
| WriteOffDebt | TransactionId | Response | N | N | N | Y | N |
| WriteOffDebt | FailureReason | Response | N | N | N | N | N |
| WriteOffDebt | Status | Response | N | N | N | N | N |
| WriteOffDebt | Errors | Response | N | N | N | N | N |
| WriteOffDebt | RequestId | Response | N | N | N | Y | N |
