Recurring-use Token Installation Pipeline

callerReference

String

Yes

This is a unique caller specific reference used in the token installation to retrieve the token installed by this pipeline

currencyCode

String

No

Specifies the currency of all amounts that this pipeline accepts. Currently only "USD" is an accepted value. If not specified, then "USD" is taken as the default.

paymentReason

String

Optional

This is a text in a human readable form that specifies the reason for this payment transaction. You can provide a limited set of HTML tags to format your text. The tags you are allowed to use are <b>, <i>, <u>, <ul>, <li>, <br>, <em>, <strong>, and <strike>. If you use any other tag, we will ignore it.

recipientToken

String

Optional

This is used to specify the intended recipient TokenId. If this value is not specified, then caller is considered to be the recipient.

transactionAmount

String

Yes

Specifies the recurring amount payable in this transaction.

validityStart

Date

Optional

The validity start date should be within one year from the current date. The date cannot be beyond one year or earlier than the current date. By default this date is current date. Provides seconds unit using the EPOCH time.

validityExpiry

Date

Optional

The expiry date has no restrictions, other than the date cannot be earlier than the current date. If no date is specified, the token is created with an indefinite expiry date.

paymentMethod

String

Optional

A comma separated string that allows you to pass payment methods supported by the recipient. You can specify only CC, ACH and ABT as payment methods. By default, all the three payment methods (CC, ACH, and ABT) are considered to be available. By default, ABT will be selected as the payment method.

recurringPeriod

String

Yes

If the usageLimitType2 is specified and this variable is not specified then the usage period should be for ever. This accepts string of the following types:

A integer followed by one of the following strings

isRecipientCobranding

Boolean

Optional

This parameter is for marketplace applications where the caller is different from the recipient. If this value is set to True, then the co-branding URL is picked up from the recipient's settings. The parameter recipientToken is mandatory if this value is set to True. If this value is False, the co-branding URL is picked up from the caller's setting. The default value of this parameter is False

collectShippingAddress

Boolean

Optional

You can specify either False or True as the values for this parameter. The default value is False. If this value is set to True, then all shipping address parameters such as addressName, addressLine1, city, and zipcode will be ignored. If this value is set to True, then the shipping/mailing address of the sender will be returned as part of the return URL.

If the sender already has a default shipping address set up on Amazon.com or any of the international Amazon retail sites, then the sender is not prompted for the shipping/mailing address. The sender, can however, have the option of changing the shipping/mailing address on the payment authorization confirmation page. If the sender does not have a default shipping address set up, he or she is prompted to choose one from the shipping addresses already on file with Amazon, or enter a new one. If this value is set to False, then no shipping/mailing address will be returned as part of the URL and the sender will not be prompted for one either.

addressName

addressLine1

addressLine2

city

state/county

zip code

String

Optional

You might choose to collect the shipping address on your website or you can have it returned as part of the return URL. In case you choose to collect the shipping address yourself, you can use these parameters to specify the sender's shipping address. This address will be displayed to the sender on the payment authorization confirmation page. If you provide an incorrect shipping address, a warning will be returned in the output parameters, warningCode and warningMessage. Please note that you must provide a way for the sender or buyer to change the shipping address on you website. If you have already received the sender token, then use the Edit Token Pipeline to change the shipping address on the token.

status

String

This is the status of the UI pipeline call. List of predefined status codes. Documented with each pipeline. Always returned back from the pipeline.

errorMessage

String

This is a text in a human readable form that specifies the reason for this payment transaction failure.

expiry

String

This specifies the expiry (if any) of the associated with payment method.

tokenID

String

This specifies the TokenID string associated with an installed token.

warningMessage

String

There might be cases when the sender token is installed successfully but there is an associated warning. This parameter specifies a human readable text that explains the warning corresponding to the warningCode.

warningCode

String

There might be cases when the sender token is installed successfully but there is an associated warning. This parameter denotes the warning in such cases. Here is a list of possible values of this parameter.

addressName

addressLine1

addressLine2

city

state/county

zip code

String

These parameters will be returned only if the collectShippingAddress parameter is set to True. These parameters specify the shipping address of the sender.

SA

Success status of the payment transaction that uses ABT as the the payment method.

SB

Success status of the payment transaction that uses ACH (bank account) as the payment method.

SC

Success status of the payment transaction that uses credit card as the payment method.

SE

Specifies a system error.

A

Specifies that the pipeline has been aborted by the user.

CE

Specifies a caller exception.

PE

Payment Method Mismatch Error: Specifies that the user does not have payment method that you have requested.

NP

This account type does not support the specified payment method.

NM

You are not registered as a 3rd party caller to make this transaction. Contact Amazon Payments for more information.