Did this page help you? Yes No Tell us about it...

Appendix: IPN Response Elements for Transactions

The details in the notification describe the payment information and the sender information for the transaction. The tables in the following sections show the values included in the payment information, which vary depending on the exact nature of the transaction.

The following IPN response elements are returned for standard and donation transactions, and for any other transaction that generates IPNs and is not specifically covered here.

Topics

Common IPN Response Elements

These response elements are common to all transactions.

Name Description

addressFullName

Full name of the buyer/sender.

Type: String

addressLine1

Sender's address (first line). For IPN, this element is returned only if the value has been updated with Amazon.

Type: String

addressLine2

Sender's address (second line). For IPN, this element is returned only if the value has been updated with Amazon.

Type: String

addressState

Sender's state. For IPN, this element is returned only if the value has been updated with Amazon.

Type: String

addressZip

Sender's post code. For IPN, this element is returned only if the value has been updated with Amazon.

Type: String

addressCountry

Sender's country. For IPN, this element is returned only if the value has been updated with Amazon.

Type: String

addressPhone

Sender's phone number. For IPN, this element is returned only if the value has been updated with Amazon.

Type: String

buyerEmail

Sender's email address.

	Note
	The `buyerEmail` element is not returned when the recipient is not the caller (i.e., marketplace transactions).

Type: String

Size: 65 bytes

buyerName

Sender's name.

Type: String

Size: 128 bytes

certificateUrl

A url specifying the location of the certificate used for signing the response.

Type: String

Max Size: 1024 bytes

customerEmail

Customer's email address.

Type: String

Size: 65 bytes

customerName

Buyer/Sender Full Name.

Type: String

Size: 128 bytes

dateInstalled

If the notificationType element (below) is TokenCancellation, this element contains the date the token was installed.

Type: String

Size: 30 bytes

isShippingAddressProvided

If the IPN results include address updates, this element contains TRUE. Otherwise this element is not present in the response.

Type: String

operation

The payment operation for this transaction.

Type: String

Max Size: 20 bytes

notificationType

Notification type may be either TokenCancellation or TransactionStatus

Type: String

Size: 20 bytes

paymentMethod

The payment method used by the sender.

Type: String

Size: 20 bytes

paymentReason

Reason for payment.

Type: String

recipientEmail

Recipient's email address.

	Note
	As a security precaution, you should always check that the recipient email is the same as the one in your original request.

Type: String

Size: 65 bytes

recipientName

Recipient's name.

Type: String

Size: 128 bytes

referenceId

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

Type: String

signature

The encoded string the caller uses to verify the IPN. Amazon Payments calculates the signature using the elements in the returnURL. The merchant must have manually signed the request..

Type: String

Size: 512 bytes

signatureVersion

A value that specifies the Signature format.

Type: Integer

Valid Values: 2

signatureMethod

A value that specifies the signing method.

Type: String

Valid Values: HmacSHA256 (preferred) and HmacSHA1.

tokenId

If notificationType is TokenCancellation, this element contains the ID of the cancelled token.

Type: String

Size: 65 bytes

tokenType

If notificationType is TokenCancellation, this element contains the type of the canceled token.

Type: String

Size: 20 bytes

transactionAmount

Specifies the amount payable in this transaction; for example, USD 10.00.

Type: String

Size: 30 bytes

transactionDate

The date when this transaction occurred, specified in seconds since the start of the epoch.

Type: Long

Size: 40 bytes

transactionId

Unique ID generated by Amazon FPS for this transaction. This element is returned if the transaction was accepted by Amazon FPS.

Type: String

Size: 35 bytes

transactionStatus

Shorthand code that specifies the status of the transaction.

Type: String

IPN Response Elements for Subscriptions

The following IPN response elements are returned for successful creation of subscriptions.

Name Description

addressLine1

Sender's address (first line). This element is returned only if the collectShippingAddress parameter was passed as true in the Amazon Simple Pay HTML form.

Type: String

addressLine2

Sender's address (second line). This element is returned only if the collectShippingAddress parameter was passed as true in the Amazon Simple Pay HTML form.

Type: String

addressName

Sender's name. This element is returned only if the collectShippingAddress parameter was passed as true in the Amazon Simple Pay HTML form.

Type: String

buyerEmail

Sender's email address.

	Note
	The `buyerEmail` element is not returned for transactions where the recipient is not the caller (i.e., marketplace transactions).

Type: String

buyerName

Sender's name.

Type: String

city

Sender's address - city. This element is returned only if the collectShippingAddress parameter was passed as true in the Amazon Simple Pay HTML form.

Type: String

country

Sender's address - country. This element is returned only if the collectShippingAddress parameter was passed as true in the Amazon Simple Pay HTML form.

Type: String

noOfPromotionTransactions

Number of transactions for this promotion. This element is only returned if there was a trial period with a special promotional rate.

Type: Integer

paymentMethod

The payment method used by the sender.

Type: String

paymentReason

Reason for payment.

Type: String

phoneNumber

Sender's telephone number. This element is returned only if the collectShippingAddress parameter was passed as true in the Amazon Simple Pay HTML form.

Type: String

promotionAmount

Amount charged for this promotion. This element is only returned if there was a trial period with a special promotional rate.

Type: String

recipientEmail

Recipient's email address.

Type: String

recipientName

Recipient's name.

Type: String

recurringFrequency

Tells how often the subscription fee will be charged.

Type: String

referenceId

Refund for

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

Type: String

signature

The encoded string the caller uses to verify the IPN. Amazon Payments calculates the signature using the elements in the returnURL. The merchant must have manually signed the request. For more information, see Handling the Receipt of IPN Notifications. We recommend that you always verify the signature using the method in How to Verify the IPN Signature.

Type: String

startValidityDate

Date the subscription begins. This is expressed as the timestamp value from the epoch in seconds.

Type: String

state

Sender's address - state. This element is returned only if the collectshippingaddress parameter was passed as true in the Amazon Simple Pay HTML form.

Type: String

status

For a successful creation, the status code returned is SubscriptionSuccessful.

Type: String

subscriptionId

A unique value identifying the subscription that is generated by Amazon Payments.

Type: String

subsciptionPeriod

Total time period to charge for the subscription.

Type: String

transactionAmount

Specifies the amount payable in this transaction; for example, USD 10.00. This element is not being returned in the current version.

Type: String

transactionSerialNumber

For Subscriptions, a unique value identifying the subscription that is generated by Amazon Payments. This element is returned only for subscription transactions.

Type: Integer

zip

Sender's zip code. This element is returned only if the collectshippingaddress parameter was passed as true in the Amazon Simple Pay HTML form.

Type: String

The following IPN response elements are returned for successful cancellation of subscriptions.

Name Description

Name	Description
`subscriptionId`	A unique value identifying the subscription that is generated by Amazon Payments. Type: String
`status`	For a successful cancellation, the status code sent is `SubscriptionCanceled`. Type: String
`statusReason`	Reason for this status. Type: String

subscriptionId

A unique value identifying the subscription that is generated by Amazon Payments.

Type: String

status

For a successful cancellation, the status code sent is SubscriptionCanceled.

Type: String

statusReason

Reason for this status.

Type: String

The following IPN elements are returned for successful completion of subscriptions.

Name Description

Name	Description
`subscriptionId`	A unique value identifying the subscription that is generated by Amazon Payments. Type: String
`status`	For a successful completion, the status code sent is `SubscriptionCompleted`. Type: String

subscriptionId

A unique value identifying the subscription that is generated by Amazon Payments.

Type: String

status

For a successful completion, the status code sent is SubscriptionCompleted.

Type: String

IPN Responses for Marketplace Transactions

The following IPN response elements are returned for marketplace transactions.

IPN Marketplace Transaction Elements

Name	Description
`buyerName`	Sender's name. Type: String
`operation`	The payment operation for this transaction. Type: String Max Size: 20 bytes
`paymentMethod`	The payment method used by the sender. Type: String
`paymentReason`	Reason for payment. Type: String
`recipientEmail`	Recipient's email address. Type: String
`recipientName`	Recipient's name. Type: String
`referenceId` `Refund for`	If you specified a referenceId in the button creation form, Amazon Payments returns the referenceId to you. Type: String
`signature`	The encoded string the caller uses to verify the IPN. Amazon Payments calculates the signature using the elements in the returnURL. The merchant must have manually signed the request. For more information, see Handling the Receipt of IPN Notifications. We recommend that you always verify the signature using the method in How to Verify the IPN Signature. Type: String
`status`	Shorthand code that specifies the status of the transaction. Type: String
`transactionAmount`	Specifies the amount payable in this transaction; for example, USD 10.00. This element is not being returned in the current version. Type: Double
`transactionDate`	The date when this transaction occurred, specified in seconds since the beginning of the epoch. Type: Long
`transactionId`	Unique ID generated by Amazon FPS for this transaction. This element is returned if the transaction was accepted by Amazon FPS. Type: String

Document Conventions
Terms of Use

Did this page help you? Yes No Tell us about it...