fahoby

Amazon Marketplace Web ServiceOff-Amazon Payments API Section

Reference (Version 2013-01-01)

2 Amazon Marketplace Web Service Off-Amazon Payments API Section Reference (Version 2013-01-01) 2

Amazon Marketplace Web Service Off-Amazon Payments API Section Reference (Version 2013-01-01) 2

Contents

Amazon Marketplace Web Service Off-Amazon Payments API Section Reference (Version2013-01-01)...................................................................................................................................................... 6

What you should know about the Amazon MWS Off-Amazon Payments API section............................7

CreateOrderReferenceForId........................................................................................................................ 10Description.................................................................................................................................................................................................10Request parameters..................................................................................................................................................................................10Response elements...................................................................................................................................................................................11Examples................................................................................................................................................................................................... 11Related topics............................................................................................................................................................................................12

GetBillingAgreementDetails........................................................................................................................ 13Description.................................................................................................................................................................................................13Request parameters..................................................................................................................................................................................13Response elements...................................................................................................................................................................................13Examples................................................................................................................................................................................................... 14Related topics............................................................................................................................................................................................15

SetBillingAgreementDetails.........................................................................................................................16Description.................................................................................................................................................................................................16Request parameters..................................................................................................................................................................................16Response elements...................................................................................................................................................................................16Examples................................................................................................................................................................................................... 16Related topics............................................................................................................................................................................................17

ConfirmBillingAgreement............................................................................................................................ 18Description.................................................................................................................................................................................................18Request parameters..................................................................................................................................................................................18Response elements...................................................................................................................................................................................18Examples................................................................................................................................................................................................... 18Related topics............................................................................................................................................................................................19

ValidateBillingAgreement............................................................................................................................ 20Description.................................................................................................................................................................................................20Request parameters..................................................................................................................................................................................20Response elements...................................................................................................................................................................................20Examples................................................................................................................................................................................................... 21Related topics............................................................................................................................................................................................21

AuthorizeOnBillingAgreement.................................................................................................................... 22Description.................................................................................................................................................................................................22Request parameters..................................................................................................................................................................................22Response elements...................................................................................................................................................................................23Examples................................................................................................................................................................................................... 23Related topics............................................................................................................................................................................................25

CloseBillingAgreement................................................................................................................................ 26Description.................................................................................................................................................................................................26Request parameters..................................................................................................................................................................................26Response elements...................................................................................................................................................................................26Examples................................................................................................................................................................................................... 26



Related topics............................................................................................................................................................................................27

SetOrderReferenceDetails........................................................................................................................... 28Description.................................................................................................................................................................................................28Request parameters..................................................................................................................................................................................28Response elements...................................................................................................................................................................................28Examples................................................................................................................................................................................................... 28Related topics............................................................................................................................................................................................29

GetOrderReferenceDetails...........................................................................................................................30Description.................................................................................................................................................................................................30Request parameters..................................................................................................................................................................................30Response elements...................................................................................................................................................................................30Examples................................................................................................................................................................................................... 30Related topics............................................................................................................................................................................................31

ConfirmOrderReference...............................................................................................................................32Description.................................................................................................................................................................................................32Request parameters..................................................................................................................................................................................32Response elements...................................................................................................................................................................................32Examples................................................................................................................................................................................................... 32Related topics............................................................................................................................................................................................33

CancelOrderReference.................................................................................................................................34Description.................................................................................................................................................................................................34Request parameters..................................................................................................................................................................................34Response elements...................................................................................................................................................................................34Examples................................................................................................................................................................................................... 34Related topics............................................................................................................................................................................................35

CloseOrderReference...................................................................................................................................36Description.................................................................................................................................................................................................36Request parameters..................................................................................................................................................................................36Response elements...................................................................................................................................................................................36Examples................................................................................................................................................................................................... 36Related topics............................................................................................................................................................................................37

Authorize....................................................................................................................................................... 38Description.................................................................................................................................................................................................38Request parameters..................................................................................................................................................................................38Response elements...................................................................................................................................................................................39Examples................................................................................................................................................................................................... 39Related topics............................................................................................................................................................................................40

GetAuthorizationDetails...............................................................................................................................41Description.................................................................................................................................................................................................41Request parameters..................................................................................................................................................................................41Response elements...................................................................................................................................................................................41Examples................................................................................................................................................................................................... 41Related topics............................................................................................................................................................................................42

Capture.......................................................................................................................................................... 43Description.................................................................................................................................................................................................43Request parameters..................................................................................................................................................................................43Response elements...................................................................................................................................................................................44Examples................................................................................................................................................................................................... 44Related topics............................................................................................................................................................................................45

GetCaptureDetails........................................................................................................................................ 46



Description.................................................................................................................................................................................................46Request parameters..................................................................................................................................................................................46Response elements...................................................................................................................................................................................46Related topics............................................................................................................................................................................................46

CloseAuthorization.......................................................................................................................................47Description.................................................................................................................................................................................................47Request parameters..................................................................................................................................................................................47Response elements...................................................................................................................................................................................47Examples................................................................................................................................................................................................... 47Related topics............................................................................................................................................................................................48

Refund........................................................................................................................................................... 49Description.................................................................................................................................................................................................49Request parameters..................................................................................................................................................................................49Response elements...................................................................................................................................................................................50Examples................................................................................................................................................................................................... 50Related topics............................................................................................................................................................................................51

GetRefundDetails..........................................................................................................................................52Description.................................................................................................................................................................................................52Request parameters..................................................................................................................................................................................52Response elements...................................................................................................................................................................................52Related topics............................................................................................................................................................................................52

GetServiceStatus.......................................................................................................................................... 53Description.................................................................................................................................................................................................53Request parameters..................................................................................................................................................................................53Response elements...................................................................................................................................................................................53Examples................................................................................................................................................................................................... 53Related topics............................................................................................................................................................................................54

Off-Amazon Payments Datatypes...............................................................................................................55Address......................................................................................................................................................................................................55AuthorizationDetails...................................................................................................................................................................................56BillingAgreementAttributes........................................................................................................................................................................ 58BillingAgreementDetails.............................................................................................................................................................................58BillingAgreementLimits.............................................................................................................................................................................. 60BillingAgreementStatus............................................................................................................................................................................. 60Buyer......................................................................................................................................................................................................... 61CaptureDetails........................................................................................................................................................................................... 61Constraint.................................................................................................................................................................................................. 62Destination.................................................................................................................................................................................................62OrderReferenceAttributes..........................................................................................................................................................................63OrderReferenceDetails.............................................................................................................................................................................. 63OrderReferenceStatus...............................................................................................................................................................................65OrderTotal..................................................................................................................................................................................................65Price...........................................................................................................................................................................................................66RefundDetails............................................................................................................................................................................................ 66SellerBillingAgreementAttributes............................................................................................................................................................... 67SellerOrderAttributes................................................................................................................................................................................. 67Status.........................................................................................................................................................................................................68

Billing Agreement Constraints................................................................................................................... 70

Billing Agreement States and Reason Codes.......................................................................................... 71

Order Reference Constraints......................................................................................................................73



Order Reference States and Reason Codes............................................................................................. 74

Authorization States and Reason Codes.................................................................................................. 76

Capture States and Reason Codes............................................................................................................78

Refund States and Reason Codes.............................................................................................................79

Error codes................................................................................................................................................... 80

Client library updates.................................................................................................................................. 82



Amazon Marketplace Web Service Off-Amazon Payments API Section Reference(Version 2013-01-01)

Copyright © 2013-2014 Amazon.com, Inc. or its affiliates.

AMAZON and AMAZON.COM are registered trademarks of Amazon.com, Inc. or its affiliates. All other trademarksare the property of their respective owners.

Last updated: 2014-12-15



What you should know about the AmazonMWS Off-Amazon Payments API section

Overview

The Off-Amazon Payments API section helps you to process payments for purchases made by buyers on your websiteusing the Login and Pay with Amazon service. This API section enables you to programmatically retrieve shipping andpayment information provided by the buyer from their Amazon account. It allows you to authorize, capture, and refundpayments, enabling a variety of payments scenarios.

Note: The Off-Amazon Payments API section is only applicable to payments made through the Login and Paywith Amazon service offered by Amazon Payments. You cannot use this API section to process payments forAmazon Marketplace, Amazon Webstore, or Checkout by Amazon.

Using the Off-Amazon Payments API section of Amazon Marketplace Web Service (Amazon MWS), you can:

• Create and manage a billing agreement to secure the buyer's permission to charge their selected payment method ona recurring basis without requiring their permission each time. You typically do not need a billing agreement if yourbuyers will visit your site each time they place an order or if you do not need to enable automatic payments. With abilling agreement, you can:

• Obtain the shipping information from the buyer so that you can calculate shipping charges and tax for automaticpayments.

• Obtain information about the amount that you are allowed to charge a buyer each month using AmazonPayments.

• Set the description and other optional information about the automatic payment.• Confirm the billing agreement after the buyer has signed up for automatic payments on your site.• Close the billing agreement if you or the buyer want to terminate the automatic payment relationship.

• Create and manage a limited representation of an order, hereafter referred to as an order reference or OrderReference object, through the Login and Pay with Amazon service. With an order reference, you can:

• Obtain shipping information from the buyer so you can calculate shipping charges and tax.• Set the amount, description, and other optional information for the order.• Confirm the order once the buyer has finished placing an order on your website.• Cancel the order at the request of either the buyer or yourself.• Close the order after it has been processed and completed.

• Programmatically authorize, capture, and refund money for purchases made by the buyer at your website.

For more information about integrating your website with the Login and Pay with Amazon product, see the Login andPay with Amazon Integration Guide. The "Getting started" section will walk you through a complete purchase frombeginning to end.

Terminology

The following table defines terminology for this API section:

Term Description

Billing Agreement A billing agreement, or Billing Agreement object, tracks thebuyer’s preferred payment method, preferred shipping address, andauthorization for automatic payments. A billing agreement can have anindefinite lifetime and support an indefinite number of purchases.

Order Reference An order reference, or Order Reference object, is a record of eachpurchase made by the buyer. It tracks the payment method, shipping



Term Description

address, and the amount that the buyer agreed to pay for that purchase.For each automatic payment, an order reference is created from theshipping and payment information stored in the billing agreement. Anorder reference is valid for 180 days and applies to only one purchase.You may have up to 10 authorizations on an order reference.

Authorization An authorization, or Authorization object, tracks the availabilityof funds and secures them for future payment against the paymentinstrument(s) stored in the order reference.

Capture A capture, or Capture object, tracks the movement of funds previouslysecured by authorization from the buyer’s payment instrument(s) to theseller’s account.

Refund A refund, or Refund object, tracks the movement of previously capturedfunds from the seller’s account to the buyer’s payment instrument(s).

Transaction A transaction is a generic term that is used for all the types of paymentevents against an order reference. This includes authorizations, captures,refunds, A-to-z Claims, charge backs, fees, and other miscellaneoustransactions.

Endpoints

All API calls to the Off-Amazon Payments API section service should be submitted to the following endpoints:

• Germany (DE) and United Kingdom (UK):

• Production: https://mws-eu.amazonservices.com/OffAmazonPayments/2013-01-01/• Sandbox: https://mws-eu.amazonservices.com/OffAmazonPayments_Sandbox/2013-01-01/

• United States (US):

• Production: https://mws.amazonservices.com/OffAmazonPayments/2013-01-01/• Sandbox: https://mws.amazonservices.com/OffAmazonPayments_Sandbox/2013-01-01/

Operations

The Off-Amazon Payments API section contains the following operations:

Operation Description

CreateOrderReferenceForId Creates an order reference for the given object.

GetBillingAgreementDetails Returns details about the Billing Agreement object and its current state.

SetBillingAgreementDetails Sets billing agreement details such as a description of the agreement andother information about the seller.

ConfirmBillingAgreement Confirms that the billing agreement is free of constraints and allrequired information has been set on the billing agreement.

ValidateBillingAgreement Validates the status of the BillingAgreement object and the paymentmethod associated with it.

AuthorizeOnBillingAgreement Reserves a specified amount against the payment method(s) stored inthe billing agreement.

CloseBillingAgreement Confirms that you want to terminate the billing agreement with thebuyer and that you do not expect to create any new order references orauthorizations on this billing agreement.



Operation Description

SetOrderReferenceDetails Sets order reference details such as the order total and a description forthe order.

GetOrderReferenceDetails Returns details about the Order Reference object and its current state.

ConfirmOrderReference Confirms that the order reference is free of constraints and all requiredinformation has been set on the order reference.

CancelOrderReference Cancels a previously confirmed order reference.

CloseOrderReference Confirms that an order reference has been fulfilled (fully or partially)and that you do not expect to create any new authorizations on this orderreference.

Authorize Reserves a specified amount against the payment method(s) stored inthe order reference.

GetAuthorizationDetails Returns the status of a particular authorization and the total amountcaptured on the authorization.

Capture Captures funds from an authorized payment instrument.

GetCaptureDetails Returns the status of a particular capture and the total amount refundedon the capture.

CloseAuthorization Closes an authorization.

Refund Refunds a previously captured amount.

GetRefundDetails Returns the status of a particular refund.



CreateOrderReferenceForIdCreates an order reference for the given object.

DescriptionThe CreateOrderReferenceForId operation is used to create an Order Reference object from the object representedby the Id and IdType request parameters.

For order references created from a Billing Agreement object, only one order reference can be created while the billingagreement is in the Draft state. Any number of order references can be created once the billing agreement is in theOpen state. The buyer, shipping address, and payment method for the order reference are populated from the billingagreement. To create an Order Reference object in the Confirmed state, set the ConfirmNow request parameter totrue.

This operation has a maximum request quota of 10 and a restore rate of one request every second in the productionenvironment. It has a maximum request quota of two and a restore rate of one request every two seconds in the sandboxenvironment. For definitions of throttling terminology and for a complete explanation of throttling, see "Throttling:Limits to how often you can submit requests" in the Amazon MWS Developer Guide.

Request parametersFor more information about the request parameters that are required for all Amazon MWS operations, see "Requiredrequest parameters" in the Amazon MWS Developer Guide.

Name Description Required Valid values

Id The identifier of the object to be used tocreate an order reference.

Type: xs:string

Yes Currently, the only accepted value is abilling agreement identifier. This valueis retrieved from the Amazon Button,AddressBook, or Wallet widgets.

IdType The type of the object represented bythe Id request parameter.

Type: xs:string

Yes IdType values:

• BillingAgreement - Specifies thatId is a Billing Agreement identifier.

InheritShippingAddress Specifies whether to inherit theshipping address details from the objectrepresented by the Id request parameter.

Type: xs:boolean

No Default: true

ConfirmNow Indicates whether to directly confirmthe requested order reference.

Type: xs:boolean

No ConfirmNow values:

• true - The order referenceis directly confirmed. Youdo not need to call theConfirmOrderReferenceoperation.

• false - You must call theConfirmOrderReferenceoperation to confirm the orderreference.

Default: false

OrderReferenceAttributes The seller-specified attributes of theorder reference.

Type: OrderReferenceAttributes

Required only ifConfirmNow istrue.



Response elementsName Description

OrderReferenceDetails Encapsulates details about the Order Reference object and its currentstate.

Type: OrderReferenceDetails

Examples

Example query request

POST /OffAmazonPayments/2013-01-01 HTTP/1.1Content-Type: x-www-form-urlencodedHost: mws.amazonservices.comUser-Agent: <Your User Agent Header>

AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=CreateOrderReferenceForId&Id=C01-1234567-1234567&IdType=BillingAgreement&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-10-03T19%3A01%3A11Z&Version=2013-01-01&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

Example response

<CreateOrderReferenceForIdResponse xmlns="http://mws.amazonservices.com/ schema/OffAmazonPayments_Sandbox/2013-01-01"><CreateOrderReferenceForIdResult> <OrderReferenceDetails> <AmazonOrderReferenceId>S01-1234567-1234567</AmazonOrderReferenceId> <CreationTimestamp>2013-12-05T00:21:19Z</CreationTimestamp> <ExpirationTimestamp>2014-05-05T00:21:19Z</ExpirationTimestamp> <OrderReferenceStatus> <State>Draft</State> </OrderReferenceStatus> <Destination> <DestinationType>Physical</DestinationType> <PhysicalDestination> <City>New York</City> <StateOrRegion>NY</StateOrRegion> <PostalCode>10101-9876</PostalCode> <CountryCode>US</CountryCode> </PhysicalDestination> </Destination> <ReleaseEnvironment>Live</ReleaseEnvironment> </OrderReferenceDetails></CreateOrderReferenceForIdResult><ResponseMetadata> <RequestId>5f20169b-7ab2-11df-bcef-d35615e2b044</RequestId></ResponseMetadata></CreateOrderReferenceForIdResponse>



Related topicsWhat you should know about the Amazon MWS Off-Amazon Payments API section



GetBillingAgreementDetailsReturns details about the Billing Agreement object and its current state.

DescriptionThe GetBillingAgreementDetails operation returns details about the Billing Agreement object and its current state.A Billing Agreement object provides details about the following:

• Buyer• Description• Destination (optional)• Seller billing agreement details (optional)• List of constraints (optional)

This operation has a maximum request quota of 20 and a restore rate of two requests every second in the productionenvironment. It has a maximum request quota of five and a restore rate of one request every second in the sandboxenvironment. For definitions of throttling terminology and for a complete explanation of throttling, see "Throttling:Limits to how often you can submit requests" in the Amazon MWS Developer Guide.



AmazonBillingAgreementId The billing agreement identifier.

Type: xs:string

Yes This value is retrieved from the AmazonButton, AddressBook, or Walletwidgets.

AddressConsentToken The buyer address consenttoken. You must provide a validAddressConsentToken if you wantto get the full shipping address beforethe billing agreement is confirmed.Otherwise you will only receivethe city, state, postal code, andcountry before you confirm the billingagreement.

Type: xs:string

No This value is retrieved from theAmazon Button widget after the buyerhas successfully authenticated withAmazon.


BillingAgreementDetails Encapsulates details about the Billing Agreement object and its currentstate.

Type: BillingAgreementDetails



Examples



AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=GetBillingAgreementDetails&AmazonBillingAgreementId=C01-8824045-7416542&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2013-12-11T10%3A38%3A44.000Z&Version=2013-01-01&Signature=gP11oEBaaiQdASWsLDyid18Wn%2BB%2FKZQQtKgpHCtEXAMPLE

Example response

<GetBillingAgreementDetailsResponse xmlns="https://mws.amazonservices.com/ schema/OffAmazonPayments_Sandbox/2013-01-01"><GetBillingAgreementDetailsResult> <BillingAgreementDetails> <AmazonBillingAgreementId>C01-8824045-7416542</AmazonBillingAgreementId> <Constraints> <ConstraintID>BuyerConsentNotSet</ConstraintID> <Description> Buyer has not given consent for this Billing Agreement. </Description> </Constraints> <CreationTimestamp>2013-12-05T00:21:19Z</CreationTimestamp> <Destination> <DestinationType>Physical</DestinationType> <PhysicalDestination> <City>Seattle</City> <CountryCode>US</CountryCode> <PostalCode>98104</PostalCode> <StateOrRegion>WA</StateOrRegion> </PhysicalDestination> </Destination> <BillingAgreementLimits> <AmountLimitPerTimePeriod> <CurrencyCode>USD</CurrencyCode> <Amount>500</Amount> </AmountLimitPerTimePeriod> <TimePeriodStartDate>2013-12-01T00:00:00Z</TimePeriodStartDate> <TimePeriodEndDate>2014-01-01T00:00:00Z</TimePeriodEndDate> <CurrentRemainingBalance> <CurrencyCode>USD</CurrencyCode> <Amount>94.50</Amount> </CurrentRemainingBalance> </BillingAgreementLimits> <BillingAgreementStatus> <State>Draft</State> </BillingAgreementStatus> <ReleaseEnvironment>Sandbox</ReleaseEnvironment>



</BillingAgreementDetails></GetBillingAgreementDetailsResult><ResponseMetadata> <RequestId>4a08624e-fffa-4fe7-bc19-ef9330c42f6a</RequestId></ResponseMetadata></GetBillingAgreementDetailsResponse>




SetBillingAgreementDetailsSets billing agreement details such as a description of the agreement and other information about the seller.

DescriptionCall the SetBillingAgreementDetails operation to specify billing agreement details such as a description of theagreement and other information about the seller.





Type: xs:string


BillingAgreementAttributes The seller-specified attributes of thebilling agreement.

Type: BillingAgreementAttributes

Yes


BillingAgreementDetails Encapsulates details about the Billing Agreement object and its currentstate.

Type: BillingAgreementDetails

Examples



AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=SetBillingAgreementDetails&AmazonBillingAgreementId=C01-8824045-7416542&BillingAgreementAttributes.PlatformId=PLATFORM_ID_HERE&BillingAgreementAttributes.SellerNote=APPROVE%20LITE%20APPROVE%20HEAVY&BillingAgreementAttributes.SellerBillingAgreementAttributes .CustomInformation=Example%20Customer%20Info



&BillingAgreementAttributes.SellerBillingAgreementAttributes .StoreName=Test%20Store%20Name&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2013-12-11T10%3A57%3A18.000Z&Version=2013-01-01&Signature=Z0ZVgWu0ICF4FLxt1mTjyK%2BjdYG6Kmm8JxLTfsQEXAMPLE

Example response

<SetBillingAgreementDetailsResponse xmlns="https://mws.amazonservices.com/ schema/OffAmazonPayments_Sandbox/2013-01-01"><SetBillingAgreementDetailsResult> <BillingAgreementDetails> <AmazonBillingAgreementId>C01-8824045-7416542</AmazonBillingAgreementId> <CreationTimestamp>2013-12-05T00:21:19Z</CreationTimestamp> <Destination> <DestinationType>Physical</DestinationType> <PhysicalDestination> <City>Seattle</City> <CountryCode>US</CountryCode> <PostalCode>98104</PostalCode> <StateOrRegion>WA</StateOrRegion> </PhysicalDestination> </Destination> <BillingAgreementConsent>true</BillingAgreementConsent> <BillingAgreementStatus> <State>Draft</State> </BillingAgreementStatus> <BillingAgreementLimits> <AmountLimitPerTimePeriod> <CurrencyCode>USD</CurrencyCode> <Amount>500</Amount> </AmountLimitPerTimePeriod> <TimePeriodStartDate>2013-12-01T00:00:00Z</TimePeriodStartDate> <TimePeriodEndDate>2013-12-23T23:59:59Z</TimePeriodEndDate> <CurrentRemainingBalance> <CurrencyCode>USD</CurrencyCode> <Amount>94.50</Amount> </CurrentRemainingBalance> </BillingAgreementLimits> <ReleaseEnvironment>Sandbox</ReleaseEnvironment> <SellerNote>APPROVE LITE APPROVE HEAVY</SellerNote> <SellerBillingAgreementAttributes> <CustomInformation>Example Customer Info</CustomInformation> <StoreName>Test Store Name</StoreName> </SellerBillingAgreementAttributes> </BillingAgreementDetails></SetBillingAgreementDetailsResult><ResponseMetadata> <RequestId>bab23c81-f7c9-4d1a-b76b-fbcec07e47f5</RequestId></ResponseMetadata></SetBillingAgreementDetailsResponse>




ConfirmBillingAgreementConfirms that the billing agreement is free of constraints and all required information has been set on the billingagreement.

DescriptionCall the ConfirmBillingAgreement operation once the billing agreement is free of constraints, indicatingthat all required information has been set on the billing agreement. On successful completion of theConfirmBillingAgreement call, the billing agreement moves to the Open state.

You cannot modify the billing agreement once it is confirmed. However, the buyer can still update the shipping addressand payment method associated with the billing agreement.

AuthorizeOnBillingAgreement requests are only accepted on a billing agreement when it is in Open state. You cancreate multiple order references by calling the CreateOrderReferenceForId operation when the billing agreement isin the Open state.





Type: xs:string


Response elementsThis operation only returns the standard response elements.

Examples



AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=ConfirmBillingAgreement&AmazonBillingAgreementId=C01-8824045-7416542&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256



&SignatureVersion=2&Timestamp=2013-12-11T11%3A37%3A19.000Z&Version=2013-01-01&Signature=ET6V00R4fr2inSDky4olLrlS1XrQfdrV9Bj%2BiWeEXAMPLE

Example response

<ConfirmBillingAgreementResponse xmlns="https://mws.amazonservices.com/ schema/OffAmazonPayments_Sandbox/2013-01-01"><ResponseMetadata> <RequestId>2649e9a4-9a1e-4097-8ce5-bcbc307e5eb8</RequestId></ResponseMetadata></ConfirmBillingAgreementResponse>




ValidateBillingAgreementValidates the status of the BillingAgreement object and the payment method associated with it.

DescriptionCall the ValidateBillingAgreement operation once the billing agreement moves to the Open state (that is, aftera successful call to the ConfirmBillingAgreement operation). This operation validates the status of the billingagreement and the validity of the payment method associated with the billing agreement.





Type: xs:string



ValidationResult ValidationResult values:

• Success - Indicates that the validation succeeded.• Failure - Indicates that the validation failed.

Type: xs:string

FailureReasonCode Describes the reason for the ValidationResult failure.

FailureReasonCode values:

• InvalidPaymentMethod - The payment method associated with thebilling agreement is invalid.

• ValidationTimedOut - The validation timed out and could not becompleted.

Returned only if ValidationResult is Failure.

Type: xs:string

BillingAgreementStatus Indicates the current status of the billing agreement.

Type: BillingAgreementStatus



Examples



AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=ValidateBillingAgreement&AmazonBillingAgreementId=C01-8824045-7416542&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2013-12-11T10%3A38%3A44.000Z&Version=2013-01-01&Signature=gP11oEBaaiQdASWsLDyid18Wn%2BB%2FKZQQtKgpHCtEXAMPLE

Example response

<ValidateBillingAgreementResponse xmlns="https://mws.amazonservices.com/ schema/OffAmazonPayments_Sandbox/2013-01-01"><ValidateBillingAgreementResult> <ValidationResult>Failure</ValidationResult> <FailureReasonCode>InvalidPaymentMethod</FailureReasonCode> <BillingAgreementStatus> <LastUpdateTimestamp>2013-12-05T00:21:19Z</LastUpdateTimestamp> <State>Suspended</State> <ReasonCode>InvalidPaymentMethod</ReasonCode> <ReasonDescription>Payment method is not valid.</ReasonDescription> </BillingAgreementStatus></ValidateBillingAgreementResult><ResponseMetadata> <RequestId>f42df4b1-8047-11df-8d5c-bf56a38ef3b4</RequestId></ResponseMetadata></ValidateBillingAgreementResponse>




AuthorizeOnBillingAgreementReserves a specified amount against the payment method(s) stored in the billing agreement.

DescriptionThe AuthorizeOnBillingAgreement operation reserves a specified amount against the payment method(s) storedin the billing agreement. To charge the payment method(s), you must either set the CaptureNow request parameterto true, or call the Capture operation after you call this operation. An authorization is only valid for a particular timeperiod, which is specified in the response of the operation. At the end of the time period, the authorization expires and anotification is sent to you if you have set up Instant Payment Notifications (IPNs). For more information about InstantPayment Notifications, see "Synchronizing your systems with Amazon Payments" in the Login and Pay with AmazonIntegration Guide. You can also query the details about an authorization by calling the GetAuthorizationDetailsoperation.

Note: This is a convenience operation that creates and confirms an Order Reference object, requests anauthorization, and then closes the order reference.





Type: xs:string


AuthorizationReferenceId The identifier for this authorizationtransaction that you specify. Thisidentifier must be unique for all yourauthorization transactions.

Type: xs:string

Yes Amazon recommends that you use onlythe following characters: lowercase a-z,uppercase A-Z, numbers 0-9, dash (-),or underscore (_).

Maximum: 32 characters

AuthorizationAmount Represents the amount to be authorized.

Type: Price

Yes

SellerAuthorizationNote A description for the transaction that isdisplayed in emails to the buyer.

Type: xs:string

No Maximum: 255 characters

TransactionTimeout The number of minutes after whichthe authorization will automaticallybe closed and you will not be able tocapture funds against the authorization.

Type: xs:nonNegativeInteger

No Zero or integral values in multiples offive (5, 10, 15, etc.)

Minimum: 0

Maximum: 1440

Default: 1440

A value of zero always returns asynchronous Open or Declined status.A non-zero value always returns aPending status, and you will receive




the final processing status by InstantPayment Notification (IPN).

CaptureNow Indicates whether to directlycapture the amount specified bythe AuthorizationAmount requestparameter against an order reference(without needing to call Capture andwithout waiting until the order ships).The captured amount is disbursed toyour account in the next disbursementcycle.

Type: xs:boolean

No CaptureNow values:

• true - The specified amount isdirectly captured. You do not needto call the Capture operation.

• false - You must call the Captureoperation to capture the fundsspecified in this authorization.

Default: false

SoftDescriptor The description to be shown on thebuyer’s payment instrument statementif CaptureNow is set to true. The softdescriptor sent to the payment processoris: “AMZ* <soft descriptor specifiedhere>”.

Type: xs:string

No Default: “AMZ*<SELLER_NAME>amzn.com/pmts WA”


SellerNote Represents a description of the orderthat is displayed in emails to the buyer.

Type: xs:string


PlatformId Represents the unique identifier of theseller's platform.

Type: xs:string

No The encrypted SellerId for the accountthat is associated with the platform orplugin being used by the seller.

SellerOrderAttributes Provides more context about anorder that is represented by an OrderReference object.

Type: SellerOrderAttributes

No

InheritShippingAddress Specifies whether to inherit theshipping address details from the objectrepresented by the Id request parameter.

Type: xs:boolean

No Default: true


AuthorizationDetails Encapsulates details about the Authorization object including the status,amount captured, and fee charged.

Type: AuthorizationDetails

AmazonOrderReferenceId The order reference identifier.

Type: xs:string

Examples





AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=AuthorizeOnBillingAgreement&AmazonBillingAgreementId=C01-1234567-1234567&AuthorizationAmount.Amount=10&AuthorizationAmount.CurrencyCode=USD&AuthorizationReferenceId=test_authorize_1&InheritShippingAddress=true&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerAuthorizationNote=For November Order&SellerId=YOUR_SELLER_ID_HERE&SellerOrderAttributes.CustomInformation=Example Information&SellerOrderAttributes.SellerOrderId=testSellerOrderId&SellerOrderAttributes.StoreName=testStore&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-10-03T19%3A01%3A11Z&TransactionTimeout=60&Version=2013-01-01&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

Example response

<AuthorizeOnBillingAgreementResponse xmlns="https://mws.amazonservices.com/ schema/OffAmazonPayments_Sandbox/2013-01-01"><AuthorizeOnBillingAgreementResult> <AuthorizationDetails> <AmazonAuthorizationId>C01-1234567-1234567-A006334</AmazonAuthorizationId> <AuthorizationReferenceId>AuthReference4</AuthorizationReferenceId> <SellerAuthorizationNote>ForNovemberOrder</SellerAuthorizationNote> <AuthorizationAmount> <Amount>20.00</Amount> <CurrencyCode>USD</CurrencyCode> </AuthorizationAmount> <CapturedAmount> <Amount>0</Amount> <CurrencyCode>USD</CurrencyCode> </CapturedAmount> <AuthorizationFee> <Amount>0.00</Amount> <CurrencyCode>USD</CurrencyCode> </AuthorizationFee> <AuthorizationStatus> <LastUpdateTimestamp>2013-12-05T00:21:19Z</LastUpdateTimestamp> <State>Pending</State> </AuthorizationStatus> <CreationTimestamp>2013-12-01T00:21:19Z</CreationTimestamp> <ExpirationTimestamp>2014-01-01T00:21:19Z</ExpirationTimestamp> <CaptureNow>false</CaptureNow> </AuthorizationDetails><AmazonOrderReferenceId>S01-1234569-1234568</AmazonOrderReferenceId></AuthorizeOnBillingAgreementResult><ResponseMetadata> <RequestId>2649e9a4-9a1e-4097-8ce5-bcbc307e5eb8</RequestId></ResponseMetadata></AuthorizeOnBillingAgreementResponse>






CloseBillingAgreementConfirms that you want to terminate the billing agreement with the buyer and that you do not expect to create any neworder references or authorizations on this billing agreement.

DescriptionCall the CloseBillingAgreement operation on a previously confirmed billing agreement to indicate that you wantto terminate the billing agreement with the buyer and that you do not expect to create any new order references orauthorizations on this billing agreement. All open authorizations on the billing agreement can still be used to capturefunds.

After successfully calling this operation, the billing agreement moves to the Closed state.





Type: xs:string


ClosureReason Describes the reason for closing thebilling agreement.

Type: xs:string



Examples



AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=CloseBillingAgreement&AmazonBillingAgreementId=C01-8824045-7416542&ClosureReason=Closing%20OR%20for%20Test&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE



&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2013-12-11T12%3A32%3A42.000Z&Version=2013-01-01&Signature=yrpMpoDfGLu567t611z27v4yJ8SURIVMKcy26sJEXAMPLE

Example response

<CloseBillingAgreementResponse xmlns="https://mws.amazonservices.com/ schema/OffAmazonPayments_Sandbox/2013-01-01"><ResponseMetadata> <RequestId>2649e9a4-9a1e-4097-8ce5-bcbc307e5eb8</RequestId></ResponseMetadata></CloseBillingAgreementResponse>




SetOrderReferenceDetailsSets order reference details such as the order total and a description for the order.

DescriptionCall the SetOrderReferenceDetails operation to specify order details such as the amount of the order, a descriptionof the order, and other order attributes.



Name Description Required Valid Values

AmazonOrderReferenceId The order reference identifier retrievedfrom the Amazon Button widget.

Type: xs:string

Yes This value is retrieved from theAmazon Button widget after the buyerhas successfully authenticated withAmazon.

OrderReferenceAttributes The seller-specified attributes of theorder reference.

Type: OrderReferenceAttributes

Yes




Examples



AWSAccessKeyId=0GS7553JW74RRM612K02EXAMPLE&Action=SetOrderReferenceDetails&AmazonOrderReferenceId=P01-1234567-1234567&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&OrderReferenceAttributes.OrderTotal.Amount=106&OrderReferenceAttributes.OrderTotal.CurrencyCode=USD



&OrderReferenceAttributes.PlatformId=PLATFORM_ID_HERE&OrderReferenceAttributes.SellerNote=Lorem%20ipsum&OrderReferenceAttributes.SellerOrderAttributes.SellerOrderId=5678-23&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-11-05T19%3A01%3A11Z&Version=2013-01-01&Signature=2RPzkOgQmDybUjk0dA54maCEXAMPLE

Example response

<SetOrderReferenceDetailsResponse xmlns="https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"><SetOrderReferenceDetailsResult> <OrderReferenceDetails> <AmazonOrderReferenceId>P01-1234567-1234567</AmazonOrderReferenceId> <OrderTotal> <Amount>106</Amount> <CurrencyCode>USD</CurrencyCode> </OrderTotal> <SellerOrderAttributes> <SellerOrderId>5678-23</SellerOrderId> </SellerOrderAttributes> <SellerNote>Lorem ipsum</SellerNote> <CreationTimestamp>2012-11-05T20:21:19Z</CreationTimestamp> <ExpirationTimestamp>2013-05-07T23:21:19Z</ExpirationTimestamp> <OrderReferenceStatus> <State>Draft</State> </OrderReferenceStatus> <Destination> <DestinationType>Physical</DestinationType> <PhysicalDestination> <City>New York</City> <StateOrRegion>NY</StateOrRegion> <PostalCode>10101-9876</PostalCode> <CountryCode>US</CountryCode> </PhysicalDestination> </Destination> <ReleaseEnvironment>Live</ReleaseEnvironment> </OrderReferenceDetails></SetOrderReferenceDetailsResult><ResponseMetadata> <RequestId>f42df4b1-8047-11df-8d5c-bf56a38ef3b4</RequestId></ResponseMetadata></SetOrderReferenceDetailsResponse>


GetOrderReferenceDetails

ConfirmOrderReference

CancelOrderReference

CloseOrderReference



GetOrderReferenceDetailsReturns details about the Order Reference object and its current state.

DescriptionThe GetOrderReferenceDetails operation returns details about the Order Reference object and its current state. AnOrder Reference object provides the following details about an order:

• Buyer• Amount• Description• Destination (optional)• Seller order attributes (optional)• List of constraints (optional)





Type: xs:string


AddressConsentToken The buyer address consent token.

Type: xs:string

No This value is retrieved from theAmazon Button widget after the buyerhas successfully authenticated withAmazon.




Examples


POST /OffAmazonPayments/2013-01-01 HTTP/1.1Content-Type: x-www-form-urlencodedHost: mws.amazonservices.com



User-Agent: <Your User Agent Header>

AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=GetOrderReferenceDetails&AddressConsentToken=IQEBLzAtAhUAjagYW4Jrgw84pCaaIDjrKoEhZXsEXAMPLE&AmazonOrderReferenceId=P01-1234567-1234567&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-11-05T19%3A01%3A11Z&Version=2013-01-01&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE

Example response

<GetOrderReferenceDetailsResponse xmlns="http://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <GetOrderReferenceDetailsResult> <OrderReferenceDetails> <AmazonOrderReferenceId>P01-1234567-1234567</AmazonOrderReferenceId> <CreationTimestamp>2012-11-05T20:21:19Z</CreationTimestamp> <ExpirationTimestamp>2013-05-07T23:21:19Z</ExpirationTimestamp> <OrderReferenceStatus> <State>Draft</State> </OrderReferenceStatus> <Destination> <DestinationType>Physical</DestinationType> <PhysicalDestination> <City>New York</City> <StateOrRegion>NY</StateOrRegion> <PostalCode>10101-9876</PostalCode> <CountryCode>US</CountryCode> </PhysicalDestination> </Destination> <ReleaseEnvironment>Live</ReleaseEnvironment> </OrderReferenceDetails> </GetOrderReferenceDetailsResult> <ResponseMetadata> <RequestId>5f20169b-7ab2-11df-bcef-d35615e2b044</RequestId> </ResponseMetadata></GetOrderReferenceDetailsResponse>


SetOrderReferenceDetails



CloseOrderReference



ConfirmOrderReferenceConfirms that the order reference is free of constraints and all required information has been set on the order reference.

DescriptionCall the ConfirmOrderReference operation after the order reference is free of constraints and all required informationhas been set on the order reference. After you call this operation, the order reference is set to the Open state and youcan submit authorizations against the order reference.

After you successfully call this operation, you should call the GetOrderReferenceDetails operation to get theremaining buyer information such as name and shipping address. Before an order reference is confirmed, only the City,StateOrRegion, PostalCode, and CountryCode elements are returned in the call to GetOrderReferenceDetails.

Note: You can only submit authorization requests when an order reference is in the Open state.





Type: xs:string



Examples



AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=ConfirmOrderReference&AmazonOrderReferenceId=P01-1234567-1234567&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256



&SignatureVersion=2&Timestamp=2012-10-03T19%3A01%3A11Z&Version=2013-01-01&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE

Example response

<ConfirmOrderReferenceResponse xmlns="https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <ResponseMetadata> <RequestId>f42df4b1-8047-11df-8d5c-bf56a38ef3b4</RequestId> </ResponseMetadata></ConfirmOrderReferenceResponse>





CloseOrderReference



CancelOrderReferenceCancels a previously confirmed order reference.

DescriptionCall the CancelOrderReference operation to cancel a previously confirmed order reference. You can only cancelan Order Reference object if there are no Completed, Closed, or Pending captures against it. If you cancel an orderreference, all authorizations associated with this order reference are also closed.

After you call this operation, the order reference is moved into the Canceled state.





Type: xs:string


CancelationReason Describes the reason for the cancelation.

Type: xs:string



Examples



AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=CancelOrderReference&AmazonOrderReferenceId=P01-1234567-1234567&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-12-19T19%3A01%3A11Z&Version=2013-01-01



&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE

Example response

<CancelOrderReferenceResponse xmlns="https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <ResponseMetadata> <RequestId>5f20169b-7ab2-11df-bcef-d35615e2b044</RequestId> </ResponseMetadata></CancelOrderReferenceResponse>





CloseOrderReference



CloseOrderReferenceConfirms that an order reference has been fulfilled (fully or partially) and that you do not expect to create any newauthorizations on this order reference.

DescriptionCall the CloseOrderReference operation to indicate that a previously confirmed order reference has been fulfilled(fully or partially) and that you do not expect to create any new authorizations on this order reference. You can stillcapture funds against open authorizations on the order reference.

After you call this operation, the order reference is moved into the Closed state.




AmazonOrderReferenceId The ID of the order reference for whichthe details are being requested.

Type: xs:string


ClosureReason Describes the reason for closing theorder reference.

Type: xs:string



Examples



AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE&Action=CloseOrderReference&AmazonOrderReferenceId=P01-1234567-1234567&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2



&Timestamp=2012-12-19T19%3A01%3A11Z&Version=2013-01-01&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE

Example response

<CloseOrderReferenceResponse xmlns="http://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <ResponseMetadata> <RequestId>5f20169b-7ab2-11df-bcef-d35615e2b044</RequestId> </ResponseMetadata></CloseOrderReferenceResponse>








AuthorizeReserves a specified amount against the payment method(s) stored in the order reference.

DescriptionThe Authorize operation reserves a specified amount against the payment method(s) stored in the order reference.To charge the payment method(s), you must either set the CaptureNow request parameter to true, or call the Captureoperation after you call this operation. An authorization is only valid for a particular time period, which is specifiedin the response of the operation. At the end of the time period, the authorization expires and a notification is sent toyou if you have set up Instant Payment Notifications. For more information about Instant Payment Notifications,see the help section at Amazon Payments. You can also query the details about an authorization by calling theGetAuthorizationDetails operation.





Type: xs:string


AuthorizationReferenceId The identifier for this authorizationtransaction that you specify. Thisidentifier must be unique for all yourauthorization transactions.

Type: xs:string



AuthorizationAmount Represents the amount to be authorized.

Type: Price

Yes Maximum:

• In the US: $150,000• In the UK: £150,000• In Germany: €150,000

SellerAuthorizationNote A description for the transaction that isdisplayed in emails to the buyer.

Type: xs:string


TransactionTimeout The number of minutes after whichthe authorization will automaticallybe closed and you will not be able tocapture funds against the authorization.

Note: In asynchronousmode, the Authorizeoperation always returnsthe State as Pending. Theauthorization remains in thisstate until it is processed byAmazon. The processingtime varies and can be

No Zero or integral values in multiplesof five (5, 10, 15, etc.). Set the valueto zero for synchronous mode. Setthe value to greater than zero forasynchronous mode.

TransactionTimeout values insynchronous mode:

• Must be 0

TransactionTimeout values inasynchronous mode:

• Minimum: 5




a minute or more. Afterprocessing is complete,Amazon will notify you ofthe final processing status.For more information, see"Synchronizing your systemswith Amazon Payments"in the Login and Pay withAmazon Integration Guide.

Type: xs:nonNegativeInteger

• Maximum: 1440• Default: 1440

CaptureNow Indicates whether to directly capturea specified amount against an orderreference (without needing to callCapture and without waiting until theorder ships). The captured amount isdisbursed to your account in the nextdisbursement cycle.

Note: The AmazonPayments policy states thatyou charge your buyer whenyou fulfill the items in theorder. You should not collectfunds prior to fulfilling theorder.

Type: xs:boolean

No CaptureNow values:

• true: The specified amount isdirectly captured. You do not needto call the Capture operation.

• false: You must call the Captureoperation to capture the fundsspecified in this authorization.

Default: false

SoftDescriptor The description to be shown on thebuyer’s payment instrument statementif CaptureNow is set to true. The softdescriptor sent to the payment processoris: “AMZ* <soft descriptor specifiedhere>”.

Type: xs:string






Examples



AWSAccessKeyId=AKIAFBM3LG5JEEXAMPLE&Action=Authorize&AmazonOrderReferenceId=P01-1234567-1234567&AuthorizationAmount.Amount=94.50&AuthorizationAmount.CurrencyCode=USD&AuthorizationReferenceId=test_authorize_1&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE



&SellerAuthorizationNote=Lorem%20ipsum&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-10-03T19%3A01%3A11Z&TransactionTimeout=60&Version=2013-01-01&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

Example response

<AuthorizeResponse xmlns=" https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <AuthorizeResult> <AuthorizationDetails> <AmazonAuthorizationId> P01-1234567-1234567-0000001 </AmazonAuthorizationId> <AuthorizationReferenceId>test_authorize_1</AuthorizationReferenceId> <SellerAuthorizationNote>Lorem ipsum</SellerAuthorizationNote> <AuthorizationAmount> <CurrencyCode>USD</CurrencyCode> <Amount>94.50</Amount> </AuthorizationAmount> <AuthorizationFee> <CurrencyCode>USD</CurrencyCode> <Amount>0</Amount> </AuthorizationFee> <AuthorizationStatus> <State>Pending</State> <LastUpdateTimestamp>2012-11-03T19:10:16Z</LastUpdateTimestamp> </AuthorizationStatus> <CreationTimestamp>2012-11-02T19:10:16Z</CreationTimestamp> <ExpirationTimestamp>2012-12-02T19:10:16Z</ExpirationTimestamp> </AuthorizationDetails> </AuthorizeResult> <ResponseMetadata> <RequestId>b4ab4bc3-c9ea-44f0-9a3d-67cccef565c6</RequestId> </ResponseMetadata></AuthorizeResponse>


GetAuthorizationDetails

CloseAuthorization



GetAuthorizationDetailsReturns the status of a particular authorization and the total amount captured on the authorization.

DescriptionCall the GetAuthorizationDetails operation to query the status of a particular authorization and to retrieveinformation about the total amount captured on the authorization. If you received a Pending status when you called theAuthorize operation, you can call this operation to get the current status.




AmazonAuthorizationId The authorization identifier that wasgenerated by Amazon in the earlier callto Authorize.

Type: xs:string

Yes




Examples



AWSAccessKeyId=AKIAFBM3LG5JEEXAMPLE&Action=GetAuthorizationDetails&AmazonAuthorizationId=P01-1234567-1234567-0000001&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-11-05T19%3A01%3A11Z



&Version=2013-01-01&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

Example response

<GetAuthorizationDetailsResponse xmlns=" https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <AuthorizationDetails> <AmazonAuthorizationId> P01-1234567-1234567-0000001 </AmazonAuthorizationId> <AuthorizationReferenceId>test_authorize_1</AuthorizationReferenceId> <SellerAuthorizationNote>Lorem ipsum</SellerAuthorizationNote> <AuthorizationAmount> <CurrencyCode>USD</CurrencyCode> <Amount>94.50</Amount> </AuthorizationAmount> <AuthorizationFee> <CurrencyCode>USD</CurrencyCode> <Amount>0</Amount> </AuthorizationFee> <AuthorizationStatus> <State>Open</State> <LastUpdateTimestamp>2012-12-10T19%3A01%3A11Z</LastUpdateTimestamp> </AuthorizationStatus> <CreationTimestamp>2012-12-10T19%3A01%3A11Z</CreationTimestamp> <ExpirationTimestamp>2013-01-10T19:10:16Z</ExpirationTimestamp> <AuthorizationDetails> <ResponseMetadata> <RequestId>b4ab4bc3-c9ea-44f0-9a3d-67cccef565c6</RequestId> </ResponseMetadata></GetAuthorizationDetailsResponse>


Authorize

CloseAuthorization



CaptureCaptures funds from an authorized payment instrument.

DescriptionCall the Capture operation to capture funds from an authorized payment instrument. To successfully capturea payment, you must call this operation on an Authorization object before it expires, as specified by theExpirationTimestamp returned in response of the Authorize operation call. You must specify a capture amount, andthe amount cannot exceed the original amount that was authorized.

You can query the status of a capture request by calling the GetCaptureDetails operation.




AmazonAuthorizationId The authorization identifier thatwas generated by Amazon inthe earlier call to Authorize orAuthorizeOnBillingAgreement.

Type: xs:string

Yes

CaptureReferenceId The identifier for this capturetransaction that you specify. Thisidentifier must be unique for all yourcapture transactions.

Type: xs:string



CaptureAmount The amount to capture in thistransaction.

This amount cannot exceed the originalamount that was authorized less anypreviously captured amount on thisauthorization.

Type: Price

Yes Maximum:


SellerCaptureNote A description for the capture transactionthat is displayed in emails to the buyer.

Type: xs:string


SoftDescriptor The description to be shown on thebuyer’s payment instrument statement.The soft descriptor sent to the paymentprocessor is: “AMZ* <soft descriptorspecified here>”.

Type: xs:string






CaptureDetails Encapsulates details about the Capture object and its status.

Type: CaptureDetails

Examples



AWSAccessKeyId=AKIAFBM3LG5JEEXAMPLE&Action=Capture&AmazonAuthorizationId=P01-1234567-1234567-0000001&CaptureAmount.Amount=94.50&CaptureAmount.CurrencyCode=USD&CaptureReferenceId=test_capture_1&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerCaptureNote=Lorem%20ipsum&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-11-05T19%3A01%3A11Z&Version=2013-01-01&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

Example response

<CaptureResponse xmlns="https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <CaptureResult> <CaptureDetails> <AmazonCaptureId>P01-1234567-1234567-0000002</AmazonCaptureId> <CaptureReferenceId>test_capture_1</CaptureReferenceId> <SellerCaptureNote>Lorem ipsum</SellerCaptureNote> <CaptureAmount> <CurrencyCode>USD</CurrencyCode> <Amount>94.50</Amount> </CaptureAmount> <CaptureStatus> <State>Completed</State> <LastUpdateTimestamp>2012-11-03T19:10:16Z</LastUpdateTimestamp> </CaptureStatus> <CreationTimestamp>2012-11-03T19:10:16Z</CreationTimestamp> </CaptureDetails> </CaptureResult> <ResponseMetadata> <RequestId>b4ab4bc3-c9ea-44f0-9a3d-67cccef565c6</RequestId> </ResponseMetadata></CaptureResponse>




GetCaptureDetails



GetCaptureDetailsReturns the status of a particular capture and the total amount refunded on the capture.

DescriptionCall the GetCaptureDetails operation to query the status of a particular capture and to retrieve information about thetotal amount refunded on the capture. If you received a Pending status when you called the Capture operation, youcan call this operation to get the current status.




AmazonCaptureId The capture identifier that wasgenerated by Amazon on the earlier callto Capture.

Type: xs:string

Yes


CaptureDetails Encapsulates details about the Capture object and its status.

Type: CaptureDetails


Capture



CloseAuthorizationCloses an authorization.

DescriptionCall the CloseAuthorization operation to close an authorization after the total amount of the authorization has beencaptured.




AmazonAuthorizationId The authorization identifier that wasgenerated by Amazon in the earlier callto Authorize.

Type: xs:string

Yes

ClosureReason A description for the closure that isdisplayed in emails to the buyer.

Type: xs:string



Examples



AWSAccessKeyId=AKIAFBM3LG5JEEXAMPLE&Action=CloseAuthorization&AmazonAuthorizationId=P01-1234567-1234567-0000001&ClosureReason=Closing%20the%20auhorization%20transaction&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-12-17T19%3A01%3A11Z&Version=2013-01-01



&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

Example response

<CloseAuthorizationResponse xmlns="https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <ResponseMetadata> <RequestId>a9aedsd6-a10y-11t8-9a3d-67gggwd565c6</RequestId> </ResponseMetadata></CloseAuthorizationResponse>


Authorize




RefundRefunds a previously captured amount.

DescriptionCall the Refund operation to refund a previously captured amount. A refund can only be requested on a capture if therefund amount does not exceed the following amounts:

• In the US: up to 15% or $75 (whichever is less) above the captured amount.• In the UK: up to 15% or £75 (whichever is less) above the captured amount.• In Germany: up to 15% or €75 (whichever is less) above the captured amount.

You call the GetRefundDetails operation to query the status of a refund.




AmazonCaptureId The capture identifier that wasgenerated by Amazon in the earlier callto Capture.

Type: xs:string

Yes

RefundReferenceId The identifier for this refund transactionthat you specify. This identifier must beunique for all your refund transactions.

Type: xs:string



RefundAmount The amount to refund.

This amount cannot exceed:

• In the US: the lesser of 15% or $75above the captured amount less theamount already refunded on thecapture.

• In the UK: the lesser of 15% or £75above the captured amount for theCapture object.

• In Germany: the lesser of 15% or€75 above the captured amount forthe Capture object.

Type: Price

Yes Maximum:


SellerRefundNote A description for the refund that isdisplayed in emails to the buyer.

Type: xs:string


SoftDescriptor The description to be shown on thebuyer’s payment instrument statement.





The soft descriptor sent to the paymentprocessor is: “AMZ* <soft descriptorspecified here>”.

Type: xs:string



RefundDetails Encapsulates details about the Refund object and its status.

Type: RefundDetails

Examples



AWSAccessKeyId=AKIAFBM3LG5JEEXAMPLE&Action=Refund&AmazonCaptureId=P01-1234567-1234567-0000002&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&RefundAmount.Amount=94.50&RefundAmount.CurrencyCode=USD&RefundReferenceId=test_refund_1&SellerRefundNote=Lorem%20ipsum&SellerId=YOUR_SELLER_ID_HERE&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2012-11-05T19%3A01%3A11Z&Version=2013-01-01&Signature=WlQ708aqyHXMkoUBk69Hjxj8qdh3aDcqpY71hVgEXAMPLE

Example response

<RefundResponse xmlns="https://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <RefundResult> <RefundDetails> <AmazonRefundId>P01-1234567-1234567-0000003</AmazonRefundId> <RefundReferenceId>test_refund_1</RefundReferenceId> <SellerRefundNote>Lorem ipsum</SellerRefundNote> <RefundType>SellerInitiated</RefundType> <RefundedAmount> <CurrencyCode>USD</CurrencyCode> <Amount>94.50</Amount> </RefundedAmount> <FeeRefunded> <CurrencyCode>USD</CurrencyCode> <Amount>0</Amount> </FeeRefunded> <RefundStatus> <State>Completed</State>



<LastUpdateTimestamp>2012-11-07T19:10:16Z</LastUpdateTimestamp> </RefundStatus> <CreationTimestamp>2012-11-05T19:10:16Z</CreationTimestamp> </RefundDetails> </RefundResult> <ResponseMetadata> <RequestId>b4ab4bc3-c9ea-44f0-9a3d-67cccef565c6</RequestId> </ResponseMetadata></RefundResponse>


GetRefundDetails



GetRefundDetailsReturns the status of a particular refund.

DescriptionCall the GetRefundDetails operation to query the status of a particular refund. If you received a Pending status whenyou called the Refund operation, you can call this operation to get the current status.




AmazonRefundId The Amazon-generated identifier forthis refund transaction.

Type: xs:string

Yes


RefundDetails Encapsulates details about the Refund object and its status.

Type: RefundDetails


Refund



GetServiceStatusReturns the operational status of the Off-Amazon Payments API section.

DescriptionThe GetServiceStatus operation returns the operational status of the Off-Amazon Payments API section of AmazonMarketplace Web Service (Amazon MWS). Status values are GREEN, GREEN_I, YELLOW, and RED.

The GetServiceStatus operation has a maximum request quota of two and a restore rate of one request every fiveminutes. For definitions of throttling terminology and for a complete explanation of throttling, see "Throttling: Limitsto how often you can submit requests" in the Amazon MWS Developer Guide.

Request parametersThe GetServiceStatus operation only accepts the required request parameters. For more information about therequest parameters that are required for all Amazon MWS operations, see "Required request parameters" in theAmazon MWS Developer Guide.


Status The following list shows possible values returned by the GetServiceStatus operation:

GREEN The service is operating normally.

GREEN_I The service is operating normally. Additional information is provided.

YELLOW The service is experiencing higher than normal error rates or is operatingwith degraded performance. Additional information may be provided.

RED The service is unavailable or experiencing extremely high error rates.Additional information may be provided.

Type: xs:string

Timestamp Indicates the time at which the operational status was evaluated.

Type: xs:dateTime

MessageId An Amazon-defined message identifier.

Type: xs:string

Messages The parent element of one or more Message elements.

Message The operational status message.

The parent element of the following child elements (both child elements are type: xs:string):

• Locale• Text

Examples


POST /OffAmazonPayments/2013-01-01 HTTP/1.1Content-Type: x-www-form-urlencoded



Host: mws.amazonservices.comUser-Agent: <Your User Agent Header>

AWSAccessKeyId=AKIAEEXAMPLENGQCJLSA&Action=GetServiceStatus&MWSAuthToken=amzn.mws.4ea38b7b-f563-7709-4bae-87aeaEXAMPLE&SellerId=A135KKEKWF1J56&SignatureMethod=HmacSHA256&SignatureVersion=2&Timestamp=2013-07-25T18%3A17%3A45Z&Version=2013-01-01&Signature=neUupEXAMPLEwJEJGnBfBGa2UpTSIZW3JMnVUYLsM4w%3D

Example response

<?xml version="1.0"?><GetServiceStatusResponse xmlns="http://mws.amazonservices.com/schema/OffAmazonPayments/2013-01-01"> <GetServiceStatusResult> <Status>GREEN</Status> <Timestamp>2013-07-25T18:17:45.167Z</Timestamp> </GetServiceStatusResult> <ResponseMetadata> <RequestId>082c41fd-2f6b-4616-a518-7db14EXAMPLE</RequestId> </ResponseMetadata></GetServiceStatusResponse>




Off-Amazon Payments DatatypesThe following datatypes are used in the request parameters and response elements of the Amazon Marketplace WebService (Amazon MWS) Off-Amazon Payments API section:

Datatype Description

Address Postal address information.

AuthorizationDetails Encapsulates details about an Authorization object including the status, amount captured, and feecharged.

BillingAgreementAttributes The seller-specified attributes of a Billing Agreement object.

BillingAgreementDetails Encapsulates details about a Billing Agreement object and its current state.

BillingAgreementLimits Represents the total amount that you can charge a buyer in a given time period.

BillingAgreementStatus Indicates the current status of a Billing Agreement object.

Buyer The name, e-mail address, and phone number of the buyer.

CaptureDetails Encapsulates details about a Capture object and its status.

Constraint Indicates mandatory information that is missing or incorrect in a Billing Agreement object or anOrder Reference object.

Destination Represents the address selected by the buyer through the AddressBook widget.

OrderReferenceAttributes The seller-specified attributes of an Order Reference object.

OrderReferenceDetails Encapsulates details about an Order Reference object and its current state.

OrderReferenceStatus Indicates the current status of an Order Reference object.

OrderTotal The total amount of an order represented by an Order Reference object.

Price Currency type and amount.

RefundDetails Encapsulates details about a Refund object and its status.

SellerBillingAgreementAttributes Provides more context about an agreement that is represented by a Billing Agreement object.

SellerOrderAttributes Provides more context about an order that is represented by an Order Reference object.

Status Indicates the current status of an Authorization object, a Capture object, or a Refund object.

AddressPostal address information.

Datatype content

The following table shows the elements of the Address datatype:

Name Description

Name The name or business name. Required.


Type: xs:string

AddressLine1 The first line of the address. At least one of AddressLine1,AddressLine2, or AddressLine3 is required.




Name Description

Type: xs:string

AddressLine2 The second line of the address. At least one of AddressLine1,AddressLine2, or AddressLine3 is required.


Type: xs:string

AddressLine3 The third line of the address. At least one of AddressLine1,AddressLine2, or AddressLine3 is required.


Type: xs:string

City The city. Required.


Type: xs:string

County The county. Optional.


Type: xs:string

District The district. Optional.


Type: xs:string

StateOrRegion The state or region. This element is free text and can be either a 2-character code, fully spelled out, or abbreviated. Required.

Note: This response element is only returned in the US.


Type: xs:string

PostalCode The postal code. Required.


Type: xs:string

CountryCode The country code, in ISO 3166 format. Required.

Type: xs:string

Phone The phone number. Required.

Type: xs:string

AuthorizationDetailsEncapsulates details about an Authorization object including the status, amount captured, and fee charged.

Datatype content

The following table shows the elements of the AuthorizationDetails datatype:



Name Description

AmazonAuthorizationId The Amazon-generated identifier for this authorization transaction.

Type: xs:string

AuthorizationReferenceId The identifier for this authorization transaction that you specify.Maximum: 32 characters.

Type: xs:string

SellerAuthorizationNote A description for the authorization transaction that is displayed inemails to the buyer.

Type: xs:string

AuthorizationAmount The amount to be authorized.

Type: Price

CapturedAmount The total amount that has been captured on this authorization.

Type: Price

AuthorizationFee The fee that was charged by Amazon for this authorization.

Type: Price

IdList A list of AmazonCaptureId identifiers that have been requested on thisAuthorization object.

This list is empty if you have not requested any captures on thisauthorization.

Type: List of Type: xs:string

CreationTimestamp The time at which the authorization was created. In ISO 8601 format.

Type: xs:dateTime

ExpirationTimestamp The time when the authorization expires and no further captures can berequested against the authorization. In ISO 8601 format.

Type: xs:dateTime

AuthorizationStatus Describes the current status of the authorization.

Note: In asynchronous mode, the Authorize operationalways returns the State as Pending. The authorizationremains in this state until it is processed by Amazon. Theprocessing time varies and can be a minute or more. Afterprocessing is complete, Amazon will notify you of the finalprocessing status. For more information, see "Synchronizingyour systems with Amazon Payments" in the Login and Paywith Amazon Integration Guide.

For more information about the State and ReasonCode responseelements, see Authorization States and Reason Codes.

Type: Status

CaptureNow Indicates whether you specified a direct capture against the orderreference. The captured amount will disbursed to your account in thenext disbursement cycle.

CaptureNow values:



Name Description

• true: The specified amount was directly captured. You do not needto call the Capture operation.

• false: You must call the Capture operation to capture the fundsspecified in this authorization.

Default: false

Type: xs:boolean

SoftDescriptor The description to be shown on the buyer’s payment instrumentstatement if CaptureNow was set to true. Maximum: 16 characters.

Type: xs:string

BillingAgreementAttributesThe seller-specified attributes of a Billing Agreement object.

Datatype content

The following table shows the elements of the BillingAgreementAttributes datatype:



Type: xs:string

At least onerequest parametermust be specified.

The encrypted SellerId for the accountthat is associated with the platform orplugin being used by the seller.

SellerNote Represents a description of the billingagreement that is displayed in emails tothe buyer.

Type: xs:string



SellerBillingAgreementAttributes Provides more context about the billingagreement that is represented by thisBilling Agreement object.

Type: SellerBillingAgreementAttributes


BillingAgreementDetailsEncapsulates details about a Billing Agreement object and its current state.

Datatype content

The following table shows the elements of the BillingAgreementDetails datatype:

Name Description

AmazonBillingAgreementId This value is retrieved from the Amazon Button, AddressBook, orWallet widgets.

Type: xs:string

BillingAgreementLimits Represents the total amount that you can charge a buyer in a given timeperiod.



Name Description

Type: BillingAgreementLimits

Buyer Provides details about the buyer. This information will only be returnedafter you confirm the billing agreement.

Type: Buyer

SellerNote Represents a description of the billing agreement that is displayedin emails to the buyer and on the Amazon Payments website. Thisresponse element is not returned if you have not set it by calling theSetBillingAgreementDetails operation.

Type: xs:string

PlatformId Represents the unique identifier of the seller's platform.

Type: xs:string

Destination Represents the address selected by the buyer through the AddressBookwidget.

Complete buyer information will only be returned after youhave confirmed the billing agreement or have specified a validAddressConsentToken in the GetBillingAgreementDetailsoperation. Until then, only the City, StateOrRegion, PostalCode, andCountryCode elements are returned.

Type: Destination

ReleaseEnvironment Indicates if the order is for a Live (Production) or Sandbox environment.

Type: xs:string

SellerBillingAgreementAttributes Provides more context about the billing agreement represented by thisBilling Agreement object. This response element is not returned if youhave not set it by calling the SetBillingAgreementDetails operation.

Type: SellerBillingAgreementAttributes

BillingAgreementStatus Indicates the current status of the billing agreement.

For more information about the State and ReasonCode responseelements, see Billing Agreement States and Reason Codes.

Type: BillingAgreementStatus

Constraints A list of constraints that indicates mandatory information that is missingor incorrect. The presence of constraints indicates that the billingagreement is not ready to be confirmed and cannot be used for paymentoperations.

For more information, see Billing Agreement Constraints.

Type: List of Constraint

CreationTimestamp The date and time, in UTC, when the billing agreement was created. InISO 8601 format.

Type: xs:dateTime

BillingAgreementConsent Indicates the current buyer's consent for the billing agreement.

Type: xs:boolean



BillingAgreementLimitsRepresents the total amount that you can charge a buyer in a given time period.

Datatype content

The following table shows the elements of the BillingAgreementLimits datatype:

Name Description

AmountLimitPerTimePeriod The maximum amount that can be charged on a billing agreementin the time period defined by TimePeriodStartDate andTimePeriodEndDate.

Type: Price

TimePeriodStartDate The start date of the period during which theAmountLimitPerTimePeriod applies.

Type: xs:dateTime

TimePeriodEndDate The end date of the period during which theAmountLimitPerTimePeriod applies.

Type: xs:dateTime

CurrentRemainingBalance The remaining balance that can be charged in the current time period.

Type: Price

BillingAgreementStatusIndicates the current status of a Billing Agreement object.

Datatype content

The following table shows the elements of the BillingAgreementStatus datatype:

Name Description

State Indicates the state that the Billing Agreement object is in. For moreinformation, see Billing Agreement States and Reason Codes.

Type: xs:string

LastUpdatedTimestamp A timestamp that indicates the time when the billing agreement statewas last updated. In ISO 8601 format. Optional if the order reference isin the Draft state.

Type: xs:dateTime

ReasonCode Optional if the billing agreement is in the Draft state. For moreinformation, see Billing Agreement States and Reason Codes.

Type: xs:string

ReasonDescription An optional description of the billing agreement status.

Type: xs:string



BuyerThe name, e-mail address, and phone number of the buyer.

Datatype content

The following table shows the elements of the Buyer datatype:

Name Description

Name The name of the buyer. Required.

Type: xs:string

Email The e-mail address of the buyer. Required.

Type: xs:string

Phone The phone number of the buyer. Required.

Type: xs:string

CaptureDetailsEncapsulates details about a Capture object and its status.

Datatype content

The following table shows the elements of the CaptureDetails datatype:

Name Description

AmazonCaptureId The Amazon-generated identifier for this capture.

Type: xs:string

CaptureReferenceId The identifier for this capture that you specify. Maximum: 32characters.

Type: xs:string

SellerCaptureNote A description for the capture that is displayed in emails to the buyer.Maximum: 255 characters.

Type: xs:string

CaptureAmount The amount to be captured.

Type: Price

RefundedAmount The total amount that has been refunded on this capture.

Type: Price

CaptureFee The fee that was charged by Amazon for this capture.

Type: Price

IdList A list of AmazonRefundId identifiers that have been requested on thisCapture object.

This list is empty if you have not requested any refunds on this capture.




Name Description

CreationTimestamp The time at which the capture was created. In ISO 8601 format.

Type: xs:dateTime

CaptureStatus Represents the current status of the capture.

For more information about the State and ReasonCode responseelements, see Capture States and Reason Codes.

Type: Status

SoftDescriptor The description to be shown on the buyer’s payment instrumentstatement. Maximum: 16 characters.

Type: xs:string

ConstraintIndicates mandatory information that is missing or incorrect in a Billing Agreement object or an Order Referenceobject.

Datatype content

The following table shows the elements of the Constraint datatype:

Name Description

ConstraintID The identifier of the constraint. For more information, see BillingAgreement Constraints or Order Reference Constraints.

Type: xs:string

Description The description of the constraint. For more information, see BillingAgreement Constraints or Order Reference Constraints.

Type: xs:string

DestinationRepresents the address selected by the buyer through the AddressBook widget.

Datatype content

The following table shows the elements of the Destination datatype:

Name Description

DestinationType DestinationType values:

• Physical

Type: xs:string

PhysicalDestination The address of the destination.

Type: Address



OrderReferenceAttributesThe seller-specified attributes of an Order Reference object.

Datatype content

The following table shows the elements of the OrderReferenceAttributes datatype:


OrderTotal Specifies the total amount of the orderrepresented by this order reference.

Type: OrderTotal

Yes


Type: xs:string

No The encrypted SellerId for the accountthat is associated with the platform orplugin being used by the seller.

SellerNote Represents a description of the orderthat is displayed in emails to the buyer.

Type: xs:string


SellerOrderAttributes Provides more context about theorder that is represented by this orderreference.


No

OrderReferenceDetailsEncapsulates details about an Order Reference object and its current state.

Datatype content

The following table shows the elements of the OrderReferenceDetails datatype:

Name Description

AmazonOrderReferenceId The order reference identifier retrieved from the Amazon Buttonwidget.

Type: xs:string

Buyer Provides details about the buyer. This information will only be returnedafter you confirm the order reference.

Type: Buyer

OrderTotal Represents the total amount for this Order Reference object. Thisresponse element is not returned if you have not set it by calling theSetOrderReferenceDetails operation.

Type: OrderTotal

PlatformId Represents the unique identifier of the seller's platform. Thisresponse element is not returned if you have not set it by calling theSetOrderReferenceDetails operation.

Type: xs:string



Name Description

SellerNote Represents a description of the order that is displayed in emails to thebuyer. This response element is not returned if you have not set it bycalling the SetOrderReferenceDetails operation. Maximum: 1024characters.

Type: xs:string

PlatformId Represents the unique identifier of the seller's platform. Thisresponse element is not returned if you have not set it by calling theSetOrderReferenceDetails operation.

Type: xs:string

Destination Represents the address selected by the buyer through the AddressBookwidget.

Complete buyer information will only be returned after youhave confirmed the order reference or have specified a validAddressConsentToken in the GetOrderReferenceDetailsoperation. Until then, only the City, StateOrRegion, PostalCode, andCountryCode elements are returned.

Type: Destination

ReleaseEnvironment Indicates if the order is for a Live (Production) or Sandbox environment.

Type: xs:string

SellerOrderAttributes Provides more context about the order represented by this orderreference. This response element is not returned if you have not set it bycalling the SetOrderReferenceDetails operation.


OrderReferenceStatus Indicates the current status of the order reference.

For more information about the State and ReasonCode responseelements, see Order Reference States and Reason Codes.

Type: OrderReferenceStatus

Constraints A list of constraints that indicates mandatory information that ismissing or incorrect. The presence of constraints indicates that the orderreference is not ready to be confirmed and cannot be used for paymentoperations.

For more information, see Order Reference Constraints.

Type: List of Constraint

CreationTimestamp The date and time, in UTC, when the order reference was created. InISO 8601 format.

Type: xs:dateTime

ExpirationTimestamp The date and time, in UTC, when the order reference will expire andwill no longer be valid for authorization requests. In ISO 8601 format.

Note: An order reference (if confirmed) expires 180 daysafter it is created. It will be canceled by Amazon if it is notconfirmed within three hours of its creation.

Type: xs:dateTime



Name Description

IdList A list of AmazonAuthorizationId identifiers that have been requestedon this Order Reference object.

This list is empty if you have not requested any authorizations on thisorder reference.


OrderReferenceStatusIndicates the current status of an Order Reference object.

Datatype content

The following table shows the elements of the OrderReferenceStatus datatype:

Name Description

State Indicates the state that the Order Reference object is in. For moreinformation, see Order Reference States and Reason Codes.

Type: xs:string

LastUpdateTimestamp A timestamp that indicates the time when the order reference state waslast updated. In ISO 8601 format. Optional if the order reference is inthe Draft state.

Type: xs:dateTime

ReasonCode Optional if the order reference is in the Draft state. For moreinformation, see Order Reference States and Reason Codes.

Type: xs:string

ReasonDescription An optional description of the order reference status.

Type: xs:string

OrderTotalThe total amount of an order represented by an Order Reference object.

Datatype content

The following table shows the elements of the OrderTotal datatype:


CurrencyCode Three-digit currency code. In ISO 4217format.

Type: xs:string

Yes The currency code is formatted basedon the ISO 4217 standard. The numberof decimal places must be appropriatefor the currency code specified. Aperiod is the only valid decimalseparator for the amount value.

Amount The currency amount.

Type: xs:string

Yes



PriceCurrency type and amount.

Datatype content

The following table shows the elements of the Price datatype:


Amount The currency amount.

Type: xs:string

Yes Minimum: 1 character

The number of decimal places mustbe appropriate for the currency codespecified. A period is the only validdecimal separator for the amount value.

CurrencyCode Three-digit currency code. In ISO 4217format.

Type: xs:string

Yes The currency code is formatted basedon the ISO 4217 standard.

RefundDetailsEncapsulates details about a Refund object and its status.

Datatype content

The following table shows the elements of the RefundDetails datatype:

Name Description

AmazonRefundId The Amazon-generated identifier for this refund transaction.

Type: xs:string

RefundReferenceId The identifier for this refund transaction that you specify. Maximum: 32characters.

Type: xs:string

SellerRefundNote A description for the refund that is displayed in emails to the buyer.Maximum: 255 characters.

Type: xs:string

RefundType Indicates the refund type.

RefundType values:

• SellerInitiated

Type: xs:string

RefundAmount The amount requested for the refund.

Type: Price

FeeRefunded The capture fee that has been refunded.

Type: Price

CreationTimestamp The time at which the refund was created. In ISO 8601 format.



Name Description

Type: xs:dateTime

RefundStatus Represents the status of the refund request.

Note: The Refund operation always returns the State asPending. The Refund object remains in this state until it isprocessed by Amazon. The refund processing time varies andcan be several hours. After processing is complete, Amazonwill notify you of the final processing status. For moreinformation, see "Synchronizing your systems with AmazonPayments" in the Login and Pay with Amazon IntegrationGuide.

For more information about the State and ReasonCode responseelements, see Refund States and Reason Codes.

Type: Status

SoftDescriptor The description to be shown on the buyer’s payment instrumentstatement. Maximum: 16 characters.

Type: xs:string

SellerBillingAgreementAttributesProvides more context about an agreement that is represented by a Billing Agreement object.

Datatype content

The following table shows the elements of the SellerBillingAgreementAttributes datatype:


SellerBillingAgreementId The seller-specified identifier of thisbilling agreement.

Type: xs:string


Amazon recommends that you use onlythe following characters: lowercase a-z,uppercase A-Z, numbers 0-9, dash (-),or underscore (_).

StoreName The identifier of the store from whichthe order was placed. This overrides thedefault value in Seller Central underSettings > Account Settings. It isdisplayed to the buyer in their emailsand transaction history on the AmazonPayments website.

Type: xs:string


CustomInformation Any additional information you wish toinclude with this billing agreement.

Type: xs:string


SellerOrderAttributesProvides more context about an order that is represented by an Order Reference object.



Datatype content

The following table shows the elements of the SellerOrderAttributes datatype:


SellerOrderId The seller-specified identifier of thisorder. This is displayed to the buyer intheir emails and transaction history onthe Amazon Payments website.

Type: xs:string

No Amazon recommends that you use onlythe following characters: lowercase a-z,uppercase A-Z, numbers 0-9, dash (-),or underscore (_).

StoreName The identifier of the store from whichthe order was placed. This overrides thedefault value in Seller Central underSettings > Account Settings. It isdisplayed to the buyer in their emailsand transaction history on the AmazonPayments website.

Type: xs:string

No

CustomInformation Any additional information you wish toinclude with this order reference.

Type: xs:string

No

StatusIndicates the current status of an Authorization object, a Capture object, or a Refund object.

Datatype content

The following table shows the elements of the Status datatype:

Name Description

State Indicates the state that the Authorization object, Capture object, orRefund object is in. For more information, see Authorization States andReason Codes, Capture States and Reason Codes, or Refund States andReason Codes.

State values:

• Pending

• Open

• Declined

• Closed

• Completed

Type: xs:string

LastUpdateTimestamp A timestamp that indicates the time when the authorization, capture, orrefund state was last updated. In ISO 8601 format.

Type: xs:dateTime

ReasonCode The reason the Authorization object, Capture object, or Refund object isin the current state. For more information, see Authorization States andReason Codes, Capture States and Reason Codes, or Refund States andReason Codes.



Name Description

Type: xs:string

ReasonDescription An optional description of the authorization, capture, or refund status.Maximum: 255 characters.

Type: xs:string



Billing Agreement Constraints

A Billing Agreement object is only eligible for creating an order reference using the CreateOrderReferenceForIdoperation or requesting a payment authorization using the AuthorizeOnBillingAgreement operation after youconfirm the billing agreement by calling the ConfirmBillingAgreement operation. The ConfirmBillingAgreementoperation call will succeed only if there are no constraints on the Billing Agreement object. Constraints indicate thatimportant information is either missing or invalid.

You can take corrective actions to fix the billing agreement and remove the constraints before calling theConfirmBillingAgreement operation. The following table lists the constraints and corrective actions you must taketo remove the constraint:

ConstraintId Description Corrective Action

BuyerConsentNotSet The buyer has not given consent for this billingagreement.

Display the Amazon Consent widget to thebuyer to obtain their consent.

ShippingAddressNotSet The buyer has not selected a shipping addressfrom the Amazon AddressBook widget.

Display the Amazon AddressBook widget tothe buyer to collect shipping information.

PaymentPlanNotSet The buyer has not set a payment method for thegiven billing agreement.

Display the Amazon Wallet widget to thebuyer to collect payment information.

Certain constraints may be added the billing agreement after it has been confirmed. In this case the billing agreementwill be moved to the Suspended state. You must take the corrective action described below and confirm the billingagreement again using the ConfirmBillingAgreement operation before calling the CreateOrderReferenceForId orAuthorizeOnBillingAgreement operations.


PaymentMethodDeleted The buyer has deleted the selected paymentmethod from his or her Amazon account.

Request the buyer to select a different paymentmethod from the Amazon Payments web siteunder Your Account > Merchant Settings.

BillingAddressDeleted The buyer has deleted the billing address ofthe selected payment method from his or herAmazon account.

Request the buyer to update the billing addressor select a different payment method fromthe Amazon Payments web site under YourAccount > Merchant Settings.

PaymentMethodExpired The selected payment method has expired. Request the buyer to update the expirationdate or select a different payment method fromthe Amazon Payments web site under YourAccount > Merchant Settings.

InvalidPaymentPlan The selected payment method is no longervalid and cannot be used.

Request the buyer to select a different paymentmethod from the Amazon Payments web siteunder Your Account > Merchant Settings.

https://payments.amazon.com






Billing Agreement States and ReasonCodes

The following diagram depicts the state transition of a Billing Agreement object:

The following table describes each state that a billing agreement can be in, the allowed operations on a state, and thereasons why a Billing Agreement object can end up in a state:

State Description Allowed Operations Reason Codes

Draft A billing agreement is in theDraft state prior to be beingconfirmed by calling theConfirmBillingAgreementoperation.

CreateOrderReferenceForId

GetBillingAgreementDetails

SetBillingAgreementDetails

ConfirmBillingAgreement

Open A Billing Agreement objectin the Draft state movesto the Open state after it isconfirmed by calling theConfirmBillingAgreementoperation.

You must also confirm the BillingAgreement object when thebuyer updates the address orpayment method for the BillingAgreement object using theAmazon AddressBook or Walletwidgets.

Authorizations can only berequested on a billing agreementthat is in the Open state.

CreateOrderReferenceForId



ValidateBillingAgreement

AuthorizeOnBillingAgreement

CloseBillingAgreement

Suspended A Billing Agreement object movesto the Suspended state when thereare problems with the paymentmethod that are preventingAmazon from processing theauthorizations. You cannotcreate new order references orrequest new authorizations whenthe billing agreement is in theSuspended state. However,



ValidateBillingAgreement

CloseBillingAgreement

InvalidPaymentMethod - Therewere problems with the paymentmethod.




you still can capture existingauthorizations and apply refundsto captures.

You should request another formof payment from the buyer if theOrder Reference object moves tothe Suspended state due to theInvalidPaymentMethod reasoncode.

Canceled The billing agreement willbe canceled by Amazon if itis not confirmed using theConfirmBillingAgreementoperation within three hours of itscreation or it can be canceled byAmazon for another reason.

Any Open authorizations andorder references will be canceledand no new payment operationswill be allowed in the future.

GetBillingAgreementDetails Stale - You did not confirm thebilling agreement by calling theConfirmBillingAgreementoperation within the allowedperiod of 3 hours.

AmazonCanceled - Amazon hascanceled the billing agreement.

Closed The billing agreement canbe closed by calling theCloseBillingAgreementoperation or it can be closed byAmazon.

You cannot create new orderreferences or request newauthorizations when the billingagreement is in the Closedstate. Captures on existingauthorizations are still allowed.Refunds on captures are also stillallowed.

GetBillingAgreementDetails AmazonClosed - Amazon hasclosed the billing agreement due toa failed internal validation.

SellerClosed - You haveexplicitly closed the billingagreement by calling theCloseBillingAgreementoperation. You can specifythe reason for closure in theClosureReason request parameterof the CloseBillingAgreementoperation.

BuyerClosed - The buyer hasclosed the billing agreement fromthe Amazon Payments website.



Order Reference Constraints

An Order Reference object is only eligible for payment authorization and capture after you confirm the order referenceby calling the ConfirmOrderReference operation. The ConfirmOrderReference operation call will succeed only ifthere are no constraints on the Order Reference object. Constraints indicate that important order reference informationis either missing or invalid.

You can take corrective actions to fix the order reference and remove the constraints before calling theConfirmOrderReference operation. The following table lists the constraints and corrective action you must take toremove the constraint:


ShippingAddressNotSet The buyer has not selected a shipping addressfrom the Amazon AddressBook widget.

Display the Amazon AddressBook widget tothe buyer to collect shipping information.

PaymentPlanNotSet The buyer has not set a payment method for thegiven order reference.

Display the Amazon Wallet widget to thebuyer to collect payment information.

AmountNotSet You have not set the amount for the orderreference.

Call the SetOrderReferenceDetailsoperation and specify the order amount in theOrderTotal request parameter.

PaymentMethodNotAllowed The payment method selected by the buyer isnot allowed for this order reference.

Display the Amazon Wallet widget andrequest the buyer to select a different paymentmethod.



Order Reference States and Reason Codes

The following diagram depicts the state transition of an Order Reference object:

The following table describes each state that an order reference can be in, the allowed operations on a state, and thereasons why an Order Reference object can end up in a state:


Draft An Order Reference object isin the Draft state prior to bebeing confirmed by callingthe ConfirmOrderReferenceoperation.




Open An Order Reference objectmoves to the Open state afterit is confirmed by calling theConfirmOrderReferenceoperation. Authorizations can onlybe requested on an order referencethat is in the Open state.


CancelOrderReference (only ifthere are no Pending, Completed,or Closed captures against theOrder Reference object)

CloseOrderReference

Authorize

Suspended An Order Reference object movesto the Suspended state whenthere are problems with thepayment method that is preventingAmazon from processing theauthorizations. You cannot requestnew authorizations when the orderreference is in the Suspendedstate. However, you still cancapture existing authorizations andapply refunds to captures.

You should request another formof payment from the buyer if theOrder Reference object moves tothe Suspended state.


CancelOrderReference (only ifthere are no Pending, Completed,or Closed captures against theOrder Reference object)

CloseOrderReference

InvalidPaymentMethod. Therewere problems with the paymentmethod.

Canceled The Order Reference objectcan be canceled by callingthe CancelOrderReferenceoperation or it can be canceled byAmazon.

GetOrderReferenceDetails SellerCanceled. You haveexplicitly canceled the orderreference by calling theCancelOrderReferenceoperation. You can specify the




You can only cancel an order ifno money has been captured orcharged on the order reference.

Any pending authorizations willbe canceled and no new paymentoperations will be allowed in thefuture.

reason for the cancelation in theCancelationReason requestparameter.

Stale. You did not confirmthe order reference by callingthe ConfirmOrderReferenceoperation within the allowedperiod of 3 hours.

AmazonCanceled. Amazon hascanceled the order reference.

Closed The Order Reference objectcan be closed by calling theCloseOrderReference operationor it can be closed by Amazon.

You cannot request newauthorizations when the orderreference is in the Closedstate. Captures on existingauthorizations are still allowed.Refunds on captures are also stillallowed.

GetOrderReferenceDetails Expired. You can only authorizefunds on the buyer’s paymentinstrument up to 180 days afterthe order reference is created.After this, Amazon will mark theorder reference as closed and newauthorizations will not be allowed.

MaxAmountCharged. You areallowed to capture the followingamounts before the order referencewill be closed by Amazon:

• In the US: up to 15% or $75(whichever is less) above theorder reference amount.

• In the UK: up to 15% or £75(whichever is less) above theorder reference amount.

• In Germany: up to 15% or €75(whichever is less) above theorder reference amount.

MaxAuthorizationsCaptured.You have fully or partiallycaptured 10 authorizations. Afterthis, the order reference will beclosed by Amazon.

AmazonClosed. Amazon hasclosed the order reference due toa failed internal validation or dueto an A-to-z claim being decidedagainst you.

SellerClosed. You haveexplicitly closed the orderreference by calling theCloseOrderReference operation.You can specify the reason forclosure in the ClosureReasonrequest parameter of theCloseOrderReference operation.



Authorization States and Reason Codes

The following diagram depicts the state transition of an Authorization object:

Note: The Pending state in the diagram below will not be present if you call the Authorize operation witha TransactionTimeout value equal to zero. You will only receive an Open or Declined status in the initialresponse.

The following table describes each Authorization object state in detail, the allowed operations on a state, and thereasons why an authorization can end up in a state.


Pending In asynchronous mode, allAuthorization objects are in thePending state for 30 secondsafter you submit the Authorizerequest.

In synchronous mode, anAuthorization object cannot be inthe Pending state.


CloseAuthorization

Open In asynchronous mode, theAuthorization object moves to theOpen state after remaining in thePending state for 30 seconds.

In synchronous mode, theAuthorization object immediatelymoves to the Open state.


Capture

CloseAuthorization

Declined The authorization has beendeclined by Amazon.

GetAuthorizationDetails InvalidPaymentMethod. Therewere problems with the paymentmethod. You should contactyour buyer and have them updatetheir payment method using theAmazon Payments web site.

AmazonRejected. Amazon hasrejected the authorization. Youshould only retry the authorizationif the order reference is in theOpen state.

ProcessingFailure. Amazon couldnot process the transaction due toan internal processing error. Youshould only retry the authorizationif the order reference is in theOpen state.

TransactionTimedOut. Inasynchronous mode, indicates




that the Authorize operationcall was not processed withinthe default timeout period of24 hours or within the timeperiod specified by you in theTransactionTimeout requestparameter. In synchronousmode, indicates that Amazoncould not process your requestwithin 6-8 seconds. If you areobserving a high number ofdeclines due to this reason code,try adjusting the timeout value inasynchronous mode, or considerusing asynchronous mode if youare using synchronous mode. Analternate approach for handlingthis error in synchronous modeis to retry the transaction inasynchronous mode.

Closed The authorization can be closed bycalling the CloseAuthorizationoperation, by calling theCancelOrderReferenceoperation, or it can be closed byAmazon.

You cannot request capturesagainst an authorization that is inthe Closed state.

In the event of a partial capture,the remaining amount willbe credited back to the orderreference.

GetAuthorizationDetails ExpiredUnused. Theauthorization has been in the Openstate for 30 days (two days forSandbox) and you did not submitany captures against it.

MaxCapturesProcessed. Youhave already captured the fullamount of the authorization.Amazon allows only one captureper authorization.

AmazonClosed. Amazon hasclosed the authorization object dueto problems with your account.

OrderReferenceCanceled. Theorder reference was canceledcausing all open authorizationsto be canceled. You can call theGetOrderReferenceDetailsoperation and check theReasonCode response element forthe cancelation reason.

SellerClosed. You have explicitlyclosed the authorization using theCloseAuthorization operation.You can specify the reason forthe closure in the ClosureReasonrequest parameter.



Capture States and Reason Codes

The following diagram depicts the state transition of a Capture object:

The following table describes each Capture state in detail, the allowed operations on a state, and the reasons why aCapture object can end up in a state.


Pending A Capture object is in the Pendingstate until it is processed byAmazon.

GetCaptureDetails

Declined You must submit a captureagainst an authorization within 30days (two days for the Sandboxenvironment). However, westrongly recommend requestinga capture within 7 days ofauthorization.

If the capture is declined. you canstill request a new authorizationand capture if the order referenceis in the Open state.

GetCaptureDetails AmazonRejected. Amazonhas rejected the capture. Youshould only retry the capture if theauthorization is in the Open state.

ProcessingFailure. Amazon couldnot process the transaction due toan internal processing error. Youshould only retry the capture if theauthorization is in the Open state.Otherwise, you should request anew authorization and then callCapture on it.

Completed The Capture object request hasbeen processed and funds will bemoved to your account in the nextdisbursement cycle.

GetCaptureDetails

Refund

Closed When the Capture object is moveto the Closed state, you cannotrequest refunds against it.

GetCaptureDetails MaxAmountRefunded. You havealready refunded the followingamounts, including any A-to-zclaims and chargebacks that youwere responsible for:

• In the US: up to 15% or $75(whichever is less) above thecaptured amount.

• In the UK: up to 15% or £75(whichever is less) above thecaptured amount.

• In Germany: up to 15% or €75(whichever is less) above thecaptured amount.

MaxRefundsProcessed. You havealready submitted 10 refunds forthis Capture object.

AmazonClosed. Amazon hasclosed the capture due to aproblem with your account or withthe buyer's account.



Refund States and Reason Codes

The following diagram depicts the state transition of a Refund object:

The following table describes each refund state in detail, the allowed operations on a state, and the reasons why aRefund object can end up in a state.


Pending A Refund object is in the Pendingstate until it is processed byAmazon.

GetRefundDetails

Declined Amazon has declined the refundbecause the maximum amount hasbeen refunded on the capture.

GetRefundDetails AmazonRejected. Amazon hasrejected the refund. You shouldissue a refund to the buyer in analternate manner (for example, agift card or store credit).

ProcessingFailure. Amazoncould not process the transactiondue to an internal processingerror or because the buyer hasalready received a refund froman A-to-z claim or a charge back.You should only retry the refundif the Capture object is in theCompleted state. Otherwise, youshould refund the buyer in analternative way (for example, astore credit or a check).

Completed The refund request has beenprocessed and funds will bereturned to the buyer.

GetRefundDetails



Error codes

The following table describes the various error codes that the Off-Amazon Payments API section can return. Fordescriptions of error codes that are common to all Amazon MWS API sections, see "Handling errors" in the AmazonMWS Developer Guide.

Error code HTTP status code Description

BillingAgreementConstraintsExist 400 The Billing Agreement object that you submitted inthis request has constraints and cannot be confirmed.Consult the error message for a list of the constraints onthe Billing Agreement object.

BillingAgreementNotModifiable 405 The Billing Agreement object that you submitted in thisrequest is confirmed and cannot be modified.

CaptureNotRefundable 405 You have attempted a refund on a Capture object that isin a state where a refund is not allowed.

ConstraintsExist 400 The Order Reference object that you submitted in thisrequest has constraints and cannot be confirmed. Consultthe error message for a list of the constraints on the OrderReference object.

DuplicateReferenceId 400 The reference identifier that you have specified in thisrequest was already used in a different Authorize,Capture, or Refund request and cannot be reused.

DuplicateRequest 400 A request with the supplied AuthorizationReferenceId,CaptureReferenceId, or RefundReferenceId hasalready been processed with different parameters.

InternalServerError 500 There was an unknown error in the service.

InvalidAccountStatus 403 Your account is not in an appropriate state to execute thisrequest. For example, your account has been suspended,you have not completed registration, etc.

InvalidAddress 400 You have provided an invalid section name or version inthe request.

InvalidAddressConsentToken 404 The AddressConsentToken is not valid. Ensure that thetoken has not expired and that it belongs to the buyer onthis contract.

InvalidAuthorizationStatus 405 You have attempted to capture or close an authorizationfor an Authorization object that is in a state where acapture or close is not allowed.

InvalidBillingAgreementId 404 The billing agreement identifier that you submitted inthis request is invalid.

InvalidBillingAgreementStatus 405 You have attempted to call an operation on a BillingAgreement object that is in a state where that operation isnot allowed.

InvalidCancelAttempt 405 The Order Reference object that you submitted in thisrequest cannot be canceled for the supplied reason.

InvalidCloseAttempt 405 The Billing Agreement object, Order Reference object,or Authorization object that you submitted in this requestcannot be closed for the supplied reason.

InvalidOrderReferenceId 404 The order reference identifier that you submitted in thisrequest is invalid.

InvalidOrderReferenceStatus 405 You have attempted to call an operation on an OrderReference object that is in a state where that operation isnot allowed.



Error code HTTP status code Description

InvalidSandboxSimulationSpecified 400 You have attempted an invalid operation for the sandboxenvironment. Consult the error message for moreinformation.

InvalidTransactionId 404 The transaction identifier that you submitted in thisrequest is invalid.

MissingAuthenticationToken 401 The request that you sent to the server does not have avalid signature.

OrderReferenceCountExceeded 403 You have attempted to create more than the maximumallowed limit of one Order Reference object on a BillingAgreement object that is in the Draft state.

OrderReferenceNotModifiable 405 The Order Reference object that you submitted in thisrequest is confirmed and cannot be modified

PaymentMethodNotUpdated 400 The buyer did not select an allowed payment methodfrom the Amazon Wallet widget when they updatedtheir address from the Amazon AddressBook widget.You have attempted to confirm the Billing Agreementobject before the buyer has selected an allowed paymentmethod.

PeriodicAmountExceeded 400 The Billing Agreement object that you submitted in thisrequest has already been authorized for the specifiedamount in the specified time period. A new authorizationcannot be accepted as the total authorization amountcannot exceed the specified limit.

RequestThrottled 503 Your request has been rejected because the request rate ishigher than the allocated throttling limits.

ServiceUnavailable 503 The service is temporarily unavailable. Please try againlater.

TransactionAmountExceeded 400 You have attempted to authorize an Order Referenceobject for an amount that exceeds the maximumauthorization amount allowed.

-or-

You have attempted to capture an Authorization objector refund a Capture object for an amount that exceeds themaximum capture or refund amount allowed.

TransactionCountExceeded 400 The number of authorizations, captures, or refunds hasexceeded one of the following maximum allowed limits:

• 10 captured or currently open authorizations perorder reference.

• 50 authorizations in any status per order reference.• One completed capture per authorization.• 10 completed refunds per capture.

UnauthorizedAccess 401 The specified seller account is not authorized to executethis request.



Client library updatesThe following tables describe the most recent updates to the Off-Amazon Payments API section client libraries:

PHP

Client libraryversion

Description

1.0.11 • Added support for the Login and Pay with Amazon service in Germany and the United Kingdom.• Unified the US and EU code examples.

1.0.10 • Updated sample code and webserver based examples for using the Fast Authorization option.• Updated library and added:

• ProviderCreditList as an additional parameter in AuthorizationRequest and CaptureRequest.• ProviderCreditReversalList as an additional parameter in RefundRequest.• ProviderCreditSummaryList as an additional parameter in CaptureResponse and CaptureNotification.• ProviderCreditReversalSummaryList as an additional parameter in RefundResponse and

RefundNotification.• Updated library and added support for Solution Provider related operations (ReverseProviderCredit,

GetProviderCreditDetails, GetProviderCreditReversalDetails) and notifications(ProviderCreditNotification, ProviderCreditReversalNotification).

• Added sample code and webserver based examples for ProviderCheckout, ProviderRefund andReverseProviderCredit.

• Added support for SolutionProviderMerchantNotification.

1.0.8 • Updated library and added BillingAddress as a whitelisted parameter in the OrderReferenceDetails object.• Updated library and added AddressVerificationCode as an additional parameter in the Authorize Notification IPN.

Note: BillingAddress and AddressVerificationCode are available only to sellers pre-approved by Amazon.Contact Amazon Payments Support or your Account manager.

C#


Description

1.0.11 • Added support for the Login and Pay with Amazon service in Germany and the United Kingdom.• Unified the US and EU code examples.• Fixed a bug with the captureNow flag in the AuthorizeOnBillingAgreement examples.







1.0.9 • Updated library and added BillingAddress as a whitelisted parameter in OrderReferenceDetails.• Updated library and added AddressVerificationCode as an additional parameter in the Authorize Notification IPN.




Java


Description

1.0.11 • Added support for the Login and Pay with Amazon service in Germany and the United Kingdom.• Unified the US and EU code examples.• Addressed issue with IPN metadata serialization found in newer versions of JAXB. Upgraded bundled JAXB libraries

to latest version (2.2.7).







1.0.9 • Updated library and added BillingAddress as a whitelisted parameter in OrderReferenceDetails.• Updated library and added AddressVerificationCode as an additional parameter in the Authorize Notification IPN.


Date post:	17-Jul-2015
Category:	Documents
Upload:	emiy-johnson
View:	101 times
Download:	2 times

fahoby

Documents