Amazon FPS API Reference

Topics

This section provides reference material for the Amazon FPS API.

The current version of the Amazon FPS API is 2008-09-17.

The WSDL is located at https://fps.amazonaws.com/doc/2008-09-17/AmazonFPS.wsdl.

The schema is located at https://fps.amazonaws.com/doc/2008-09-17/AmazonFPS.xsd.

[Note]Note

To use the Amazon FPS API, you must have an Amazon FPS developer account. For information about getting the account, go to Amazon Flexible Payments Service Getting Started Guide.

Error Codes

Error

Description

AccessFailure

Account cannot be accessed.

You can display the following message to your customers:

Your account cannot be accessed.

Retriable: Yes

AccountClosed

Account is not active.

You can display the following message to your customers: Your account is closed.

Retriable: Yes

AccountLimitsExceeded

The spending or the receiving limit on the account is exceeded.

You can display the following message to your customers: You have exceeded your spending or receiving limits. Please visit http://payments.amazon.com to update your payment limits.

Retriable: Yes

AmountOutOfRange

The transaction amount is more than the allowed range.

Ensure that you pass an amount within the allowed range. The transaction amount in a Pay operation using credit card or bank account must be greater than $0.01.

Retriable: No

ConcurrentModification

A retriable error can happen when two processes try to modify the same data at the same time.

The developer should retry the request if this error is encountered.

Retriable: Yes

DuplicateRequest

A different request associated with this caller reference already exists.

You have used the same caller reference in an earlier request. Ensure that you use unique caller references for every new request.

Even if your earlier request resulted in an error, you should still use a unique caller reference with every request and avoid this error.

Retriable: No

InactiveInstrument

Payment instrument is inactive.

The payment instrument is inactive, for example, a credit card has expired.

Retriable: No

InsufficientBalance

The sender, caller, or recipient’s account balance has insufficient funds to complete the transaction.

You must ask your customers to fund their accounts. You can then retry this request.

Funding an account can take up to three to four business days using a bank account transfer. This error is also displayed if the party paying the FPS fees does not have a sufficient account balance.

Retriable: Yes

InternalError

A retriable error that happens due to some transient problem in the system.

The caller should retry the API call if this error is encountered.

Retriable: Yes

InvalidAccountState

The account is either suspended or closed. Payment instructions cannot be installed on this account.

You must ask your customer to set up a new account if the account is closed.

Retriable: Yes

InvalidAccountState_Caller

The developer account cannot participate in the transaction.

Your account is not active. Contact your AWS Representative for more information.

Retriable: Yes

InvalidAccountState_Recipient

Recipient account cannot participate in the transaction.

You can display the following message to your customer (sender): Your Amazon Payments account is not active. Please visit http:// payments.amazon.com for more details.

Retriable: Yes

InvalidAccountState_Sender

Sender account cannot participate in the transaction.

You can display the following message to your customer (sender): Your Amazon Payments account is not active. Please visit http://payments.amazon.com for more details.

Retriable: Yes

InvalidParameter

One or more parameters in the request is invalid.

For more information, see the parameter descriptions for the action in the API Reference.

Retriable: No

InvalidSubscriptionID

The supplied subscription ID is invalid.

Please ensure that the subscription id passed in the input is correct and is owned by the calling account.

Retriable: No

InvalidSubscriptionState

This subscription is already canceled or completed.

None

Retriable: No

InvalidSenderRoleFor

  AccountType

This token cannot be used for this operation.

Ensure that the account used in this transaction is the same account used in the original transaction. In a refund transaction, the recipient making the refund payment must the be same recipient as in the original transaction.

Retriable: No

InvalidTokenId

You did not install the token that you are trying to cancel.

You do not have permission to cancel this token. You can cancel only the tokens that you own.

Retriable: No

InvalidTokenId_Recipient

The recipient token specified is either invalid or canceled.

You must install a new token if you are the recipient. If you are not the recipient, get a new payment authorization from the recipient.

Retriable: No

InvalidTokenId_Sender

The send token specified is either invalid or canceled or the token is not active.

You must ask your customer to set up a new payment authorization.

Retriable: No

InvalidTokenType

An invalid operation was performed on the token, for example, getting the token usage information on a single use token.

Retriable: No

InvalidTransactionId

The specified transaction could not be found or the caller did not execute the transaction or this is not a Pay or Reserve call.

Specify the correct the transaction ID.

Retriable: No

InvalidTransactionState

The transaction is not complete, or it has temporarily failed.

Specify a duration of more than one hour.

Retriable: No

MissingRequiredParameter

The request is missing a required parameter.

Check that you have specified all the parameters and values required by the action.

Retriable: After you have provided the complete parameter set.

OriginalTransactionFailed

The original transaction has failed.

You cannot refund a transaction that has originally failed.

Retriable: No

OriginalTransactionIncomplete

The original transaction is still in progress.

Retry after the original transaction has completed.

Retriable: Yes

RefundAmountExceeded

The refund amount is more than the refundable amount.

You are not allowed to refund more than the original transaction amount.

Retriable: No

RefundDenied

The refund was denied.

There are no successful transactions associated with this subscription that can be canceled.

Please wait for a successful payment to be made for this transaction.

Retriable: Yes

SenderNotOriginalRecipient

The sender in the refund transaction is not the recipient of the original transaction.

The token you passed as the refund sender token does not belong to the recipient of the original transaction. Pass the correct refund sender token.

Retriable: No

SettleAmountGreaterThan

ReserveDebt

The amount being settled is greater than the reserved debt.

You cannot settle an amount greater than the debt.

Retriable: No

SettleAmountGreaterThan

ReserveAmount

The amount being settled is greater than the reserved amount.

You cannot settle an amount greater than what is reserved.

Retriable: No

SystemError

There was a system error.

The transaction did not complete.

Retriable: Yes

TokenAccessDenied

Permission is denied to cancel the token.

You are not allowed to cancel this token.

Retriable: No

TokenNotActive_Recipient

The recipient token is canceled.

If you are the recipient, set up a new recipient token using the InstallPaymentInstruction operation or direct your customers to the Recipient Token Installation Pipeline to set up recipient token.

Retriable: No

TokenNotActive_Sender

The sender token is canceled.

You must ask your customer to set up a new payment authorization because the current authorization is not active.

Retriable: No

TransactionDenied

This transaction is not allowed.

You are not allowed to do this transaction. Check your credentials.

Retriable: No

TransactionFullyRefunded

  Already

This transaction has already been completely refunded.

You are not allowed to refund more than the original transaction amount.

Retriable: No

TransactionTypeNotRefundable

You cannot refund this transaction.

Refund is allowed only on the Pay operation.

Retriable: No

UnverifiedAccount_Recipient

The recipient's account must have a verified bank account or a credit card before this transaction can be initiated.

You can display the following message to your customer (recipient): Your Amazon Payments account is not active. Please visit http://payments.amazon.com for more details.

Retriable: No

UnverifiedAccount_Sender

The sender's account must have a verified U.S. credit card or a verified U.S bank account before this transaction can be initiated.

You can display the following message to your customers: Please add a U.S. credit card or U.S. bank account and verify your bank account before making this payment.

Retriable: No

UnverifiedBankAccount

A verified bank account should be used for this transaction.

Visit the http://payments.amazon.com web site to verify your bank account.

Retriable: No

UnverifiedEmailAddress_Caller

The caller account must have a verified e-mail address.

You cannot make a web service API call without verifying your e-mail address. Go to http://payments.amazon.com web site and make payments.

Retriable: No

UnverifiedEmailAddress_

  Recipient

The recipient account must have a verified e-mail address for receiving payments.

You can display the following message to your customers: You cannot receive payments. Please verify your e-mail address. Go to http://payments.amazon.com to verify your account and receive payments.

Retriable: No

UnverifiedEmailAddress_Sender

The sender account must have a verified e-mail address for this payment

You can display the following message to your customers: You cannot receive payments. Please verify your e-mail address. Go to http://payments.amazon.com to verify your account and receive payments.

Retriable: No