API Return Values

addressLine1

The line 1 of the address of the buyer. This parameter is returned in case the collectShippingAddress parameter was passed as true in the HTML form.

Type: String

Constraint: All address-related parameters associated with collectshippingaddress except addressLine2, must have values, or else none of the parameters apply.

addressLine2

The line 2 of the address of the buyer. This parameter is returned in case the collectShippingAddress parameter was passed as true in the HTML form.

Type: String

Constraint: All address-related parameters associated with collectshippingaddress except addressLine2, must have values, or else none of the parameters apply.

addressName

The name of the buyer. This parameter is returned in case the collectShippingAddress parameter was passed as true in the HTML form.

Type: String

Constraint: All address-related parameters associated with collectshippingaddress except addressLine2, must have values, or else none of the parameters apply.

buyerEmail

The email address of the buyer.

Type: String

buyerNames

The name of the buyer.

Type: String

city

The city of the address of the buyer. This parameter is returned in case the collectShippingAddress parameter was passed as true in the HTML form.

Type: String

Constraint: All address-related parameters associated with collectshippingaddress except addressLine2, must have values, or else none of the parameters apply.

country

The country of the address of the buyer. This parameter is returned in case the collectShippingAddress parameter was passed as true in the HTML form.

Type: String

Constraint: All address-related parameters associated with collectshippingaddress except addressLine2, must have values, or else none of the parameters apply.

errorMessage

A human-readable string returned for the ME status (see the following list of status codes).

Type: String

operation

The payment operation for this transaction. Can take values reserve and pay.

Type: String

Valid values: pay, reserve

paymentMethod

The payment method used by the buyer.

Type: String

paymentReason

The payment reason as specified in the user interface.

Type: String

phoneNumber

The phoneNumber of the buyer. This parameter is returned in case the collectShippingAddress parameter was passed as true in the HTML form.

Type: String

Constraint: All address-related parameters associated with collectshippingaddress except addressLine2, must have values, or else none of the parameters apply.

recipientEmail

The email address of the seller.

Type: String

recipientName

The name of payment recipient (the seller).

Type: String

referenceId

If you specified a referenceId in the button, Amazon Payments returns the referenceId to you.

Type: String

signature

Amazon Payments calculates the signature using all the parameters in the returnUrl. We recommend that you calculate the return URL's signature using the same method that you used to calculate the signature while customizing the standard button. This is to be sure that you are receiving the response from Amazon Payments. The signature is only returned when the request is signed using the seller or developer's access key. If the seller or developer chooses to use unsigned standard buttons, this parameter is not provided.

Type: String

state

The state of the address of the buyer. This parameter is returned in case the collectShippingAddress parameter was passed as true in the HTML form.

Type: String

Constraint: All address-related parameters associated with collectshippingaddress except addressLine2, must have values, or else none of the parameters apply.

status

The status of the transaction. See Return URL Status Codes for possible values for this field.

Type: String

Valid values:

transactionAmount

The amount of this transaction, for example, USD 10.00.

Type: String

transactionDate

The date when this transaction occurred, specified in seconds since January 1, 1970.

Type: String

transactionId

Type: String

The zip of the address of the buyer. This parameter is returned in case the collectShippingAddress parameter was passed as true in the HTML form.

Type: String

Constraint: All address-related parameters associated with collectshippingaddress except addressLine2, must have values, or else none of the parameters apply.