M Ws Off Amazon Payment Sap I Reference

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
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 (Version
2013-01-01)...................................................................................................................................................... 5
What you should know about the Amazon MWS Off-Amazon Payments API section............................ 6
Throttling...................................................................................................................................................................................................... 8
SetOrderReferenceDetails............................................................................................................................. 9
Description................................................................................................................................................................................................... 9
Request parameters.................................................................................................................................................................................... 9
Response elements.....................................................................................................................................................................................9
Examples..................................................................................................................................................................................................... 9
Related topics............................................................................................................................................................................................10
GetOrderReferenceDetails........................................................................................................................... 11
Description................................................................................................................................................................................................. 11
Request parameters.................................................................................................................................................................................. 11
Response elements...................................................................................................................................................................................11
Examples................................................................................................................................................................................................... 11
Related topics............................................................................................................................................................................................12
ConfirmOrderReference............................................................................................................................... 13
Description................................................................................................................................................................................................. 13
Examples................................................................................................................................................................................................... 13
Related topics............................................................................................................................................................................................14
CancelOrderReference................................................................................................................................. 15
Description................................................................................................................................................................................................. 15
Examples................................................................................................................................................................................................... 15
Related topics............................................................................................................................................................................................16
CloseOrderReference................................................................................................................................... 17
Description................................................................................................................................................................................................. 17
Examples................................................................................................................................................................................................... 17
Related topics............................................................................................................................................................................................18
Authorize....................................................................................................................................................... 19
Description................................................................................................................................................................................................. 19
Examples................................................................................................................................................................................................... 20
Related topics............................................................................................................................................................................................21
GetAuthorizationDetails............................................................................................................................... 22
Description................................................................................................................................................................................................. 22
Examples................................................................................................................................................................................................... 22
Related topics............................................................................................................................................................................................23
Capture.......................................................................................................................................................... 24
Description................................................................................................................................................................................................. 24
Examples................................................................................................................................................................................................... 25
Related topics............................................................................................................................................................................................25
GetCaptureDetails........................................................................................................................................ 26
Description................................................................................................................................................................................................. 26
Related topics............................................................................................................................................................................................26
CloseAuthorization....................................................................................................................................... 27
Description................................................................................................................................................................................................. 27
Examples................................................................................................................................................................................................... 27
Related topics............................................................................................................................................................................................28
Refund........................................................................................................................................................... 29
Description................................................................................................................................................................................................. 29
Examples................................................................................................................................................................................................... 30
Related topics............................................................................................................................................................................................31
GetRefundDetails..........................................................................................................................................32
Description................................................................................................................................................................................................. 32
Related topics............................................................................................................................................................................................32
GetServiceStatus.......................................................................................................................................... 33
Description................................................................................................................................................................................................. 33
Examples................................................................................................................................................................................................... 33
Related topics............................................................................................................................................................................................34
Off-Amazon Payments Datatypes...............................................................................................................35
Address......................................................................................................................................................................................................35
AuthorizationDetails................................................................................................................................................................................... 36
Buyer......................................................................................................................................................................................................... 38
CaptureDetails........................................................................................................................................................................................... 38
Constraint.................................................................................................................................................................................................. 39
Destination................................................................................................................................................................................................. 39
OrderReferenceAttributes.......................................................................................................................................................................... 40
OrderReferenceDetails.............................................................................................................................................................................. 40
OrderReferenceStatus............................................................................................................................................................................... 41
OrderTotal..................................................................................................................................................................................................42
Price...........................................................................................................................................................................................................42
RefundDetails............................................................................................................................................................................................ 43
SellerOrderAttributes................................................................................................................................................................................. 44
Status.........................................................................................................................................................................................................44
Order Reference Constraints...................................................................................................................... 46
Order Reference States and Reason Codes............................................................................................. 47
Authorization States and Reason Codes.................................................................................................. 49
Capture States and Reason Codes............................................................................................................51
Refund States and Reason Codes............................................................................................................. 52
Error codes................................................................................................................................................... 53
Client library updates.................................................................................................................................. 55
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 trademarks
are the property of their respective owners.
Last updated: 2014-03-11
What you should know about the Amazon
MWS Off-Amazon Payments API section
Overview
The Off-Amazon Payments API section helps you to process payments for purchases made by buyers on your website
using the Login and Pay with Amazon service. This API section enables you to programmatically retrieve shipping and
payment information provided by the buyer from their Amazon account. It allows you to authorize, capture, and refund
payments, enabling a variety of payments scenarios.
Note: The Off-Amazon Payments API section is only applicable to payments made through the Login and Pay
with Amazon service offered by Amazon Payments. You cannot use this API section to process payments for
Amazon 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 limited representation of an order, hereafter referred to as an order reference or Order
Reference 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 after 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 and
Pay with Amazon Integration Guide. The "Getting started" section will walk you through a complete purchase from
beginning to end.
Terminology
The following table defines terminology for this API section:
Term Description
Order Reference An order reference, or Order Reference object, is a limited
representation of the sellers order. Its primary purpose is to track the
following:
The parties involved in the purchase (the buyer and the seller)
The payment method
The estimated purchase amount
Shipping information (optional).
The order reference also serves as an approval by the buyer to the seller
for charging a specified amount. The seller can execute transactions
against the order reference using the operations in this API section.
Authorization An authorization, or Authorization object, tracks the availability
of funds and secures them for future payment against the payment
instrument(s) stored in the order reference.
Capture A capture, or Capture object, tracks the movement of funds previously
secured by authorization from the buyers payment instrument(s) to the
sellers account.
Term Description
Refund A refund, or Refund object, tracks the movement of previously captured
funds from the sellers account to the buyers payment instrument(s).
Transaction A transaction is a generic term that is used for all the types of payment
events against an order reference. This includes authorizations, captures,
refunds, A-to-z Claims, charge backs, fees, and other miscellaneous
transactions.
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
SetOrderReferenceDetails Sets order reference details such as the order total and a description for
the 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 required
information 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 order
reference.
Authorize Reserves a specified amount against the payment method(s) stored in
the order reference.
GetAuthorizationDetails Returns the status of a particular authorization and the total amount
captured on the authorization.
Capture Captures funds from an authorized payment instrument.
GetCaptureDetails Returns the status of a particular capture and the total amount refunded
on the capture.
CloseAuthorization Closes an authorization.
Refund Refunds a previously captured amount.
GetRefundDetails Returns the status of a particular refund.
Throttling
Describes Amazon MWS throttling concepts.
The following table explains Amazon MWS throttling concepts:
Name Description
Request quota The number of requests that you can submit at one time without
throttling. The request quota decreases with every request you submit.
The request quota increases at the restore rate. Requests are calculated
for each Amazon seller account and Amazon MWS developer account
pair.
Restore rate The rate at which your request quota increases over time, up to the
maximum request quota.
Maximum request quota The maximum size that the request quota can reach.
The documentation for each operation in the Off-Amazon Payments API section lists the maximum request quota and
restore rate for that operation.
For a complete explanation of throttling, see "Throttling: Limits to how often you can submit requests" in the Amazon
MWS Developer Guide.
SetOrderReferenceDetails
Sets order reference details such as the order total and a description for the order.
Description
Call the SetOrderReferenceDetails operation to specify order details such as the amount of the order, a description
of the order, and other order attributes.
This operation has a maximum request quota of 10 and a restore rate of one request every second in the production
environment. It has a maximum request quota of two and a restore rate of one request every two seconds in the sandbox
environment. For definitions of throttling terminology, see Throttling.
Request parameters
For more information about the request parameters that are required for all Amazon MWS operations, see "Required
request parameters" in the Amazon MWS Developer Guide.
Name Description Required Valid Values
AmazonOrderReferenceId The order reference identifier retrieved
from the Amazon Button widget.
Type: xs:string
Yes This value is retrieved from the
Amazon Button widget after the buyer
has successfully authenticated with
Amazon.
OrderReferenceAttributes The seller-specified attributes of the
order reference.
Type: OrderReferenceAttributes
Yes
Response elements
Name Description
OrderReferenceDetails Encapsulates details about the Order Reference object and its current
state.
Type: OrderReferenceDetails
Examples
Example query request
https://mws.amazonservices.com/OffAmazonPayments/2013-01-01
?AWSAccessKeyId=0GS7553JW74RRM612K02EXAMPLE
&Action=SetOrderReferenceDetails
&AmazonOrderReferenceId=P01-1234567-1234567
&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>
Related topics
What you should know about the Amazon MWS Off-Amazon Payments API section
GetOrderReferenceDetails
ConfirmOrderReference
CancelOrderReference
CloseOrderReference
Returns details about the Order Reference object and its current state.
Description
The GetOrderReferenceDetails operation returns details about the Order Reference object and its current state. An
Order Reference object provides the following details about an order:
Buyer
Amount
Description
Destination (optional)
Seller order attributes (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 production
environment. It has a maximum request quota of five and a restore rate of one request every second in the sandbox
Request parameters
AmazonOrderReferenceId The order reference identifier.
Type: xs:string
Amazon.
AddressConsentToken The buyer address consent token.
Type: xs:string
No This value is retrieved from the
Amazon.
Response elements
Name Description
OrderReferenceDetails Encapsulates details about the Order Reference object and its current
state.
Type: OrderReferenceDetails
Examples
?AWSAccessKeyId=AKIAJKYFSJU7PEXAMPLE
&Action=GetOrderReferenceDetails
&AddressConsentToken=IQEBLzAtAhUAjagYW4Jrgw84pCaaIDjrKoEhZXsEXAMPLE
&SignatureVersion=2
&Timestamp=2012-11-05T19%3A01%3A11Z
&Version=2013-01-01
&Signature=CLZOdtJGjAo81IxaLoE7af6HqK0EXAMPLE
Example response
<GetOrderReferenceDetailsResponse xmlns="http://mws.amazonservices.com/
<GetOrderReferenceDetailsResult>
<OrderReferenceDetails>
<AmazonOrderReferenceId>P01-1234567-1234567</AmazonOrderReferenceId>
<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>
Related topics
CloseOrderReference
Confirms that the order reference is free of constraints and all required information has been set on the order reference.
Description
Call the ConfirmOrderReference operation after the order reference is free of constraints and all required information
has been set on the order reference. After you call this operation, the order reference is set to the Open state and you
can submit authorizations against the order reference.
After you successfully call this operation, you should call the GetOrderReferenceDetails operation to get the
remaining 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.
Request parameters
Type: xs:string
Amazon.
Response elements
This operation only returns the standard response elements.
Examples
&Action=ConfirmOrderReference
&SignatureVersion=2
&Timestamp=2012-10-03T19%3A01%3A11Z
&Version=2013-01-01
Example response
<ConfirmOrderReferenceResponse xmlns="https://mws.amazonservices.com/schema/
OffAmazonPayments/2013-01-01">
<ResponseMetadata>
<RequestId>f42df4b1-8047-11df-8d5c-bf56a38ef3b4</RequestId>
</ResponseMetadata>
</ConfirmOrderReferenceResponse>
Related topics
CloseOrderReference
Cancels a previously confirmed order reference.
Description
Call the CancelOrderReference operation to cancel a previously confirmed order reference. You can only cancel
an Order Reference object if there are no Completed, Closed, or Pending captures against it. If you cancel an order
reference, all authorizations associated with this order reference are also closed.
After you call this operation, the order reference is moved into the Canceled state.
Request parameters
Type: xs:string
Amazon.
CancelationReason Describes the reason for the cancelation.
Type: xs:string
No Maximum: 1024 characters
Response elements
Examples
&Action=CancelOrderReference
&SignatureVersion=2
&Timestamp=2012-12-19T19%3A01%3A11Z
&Version=2013-01-01
Example response
<CancelOrderReferenceResponse xmlns="https://mws.amazonservices.com/schema/
<ResponseMetadata>
</ResponseMetadata>
</CancelOrderReferenceResponse>
Related topics
CloseOrderReference
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 order reference.
Description
Call 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 still
capture funds against open authorizations on the order reference.
After you call this operation, the order reference is moved into the Closed state.
Request parameters
AmazonOrderReferenceId The ID of the order reference for which
the details are being requested.
Type: xs:string
Amazon.
ClosureReason Describes the reason for closing the
order reference.
Type: xs:string
Response elements
Examples
&Action=CloseOrderReference
&SignatureVersion=2
&Timestamp=2012-12-19T19%3A01%3A11Z
&Version=2013-01-01
Example response
<CloseOrderReferenceResponse xmlns="http://mws.amazonservices.com/schema/
<ResponseMetadata>
</ResponseMetadata>
</CloseOrderReferenceResponse>
Related topics
Authorize
Reserves a specified amount against the payment method(s) stored in the order reference.
Description
The 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 Capture
operation after you call this operation. An authorization is only valid for a particular time period, which is specified
in the response of the operation. At the end of the time period, the authorization expires and a notification is sent to
you 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 the
GetAuthorizationDetails operation.
Request parameters
Type: xs:string
Amazon.
AuthorizationReferenceId The identifier for this authorization
transaction that you specify. This
identifier must be unique for all your
authorization transactions.
Type: xs:string
Yes Amazon recommends that you use only
the following characters: lowercase a-z,
uppercase A-Z, dash (-), or underscore
(_).
Maximum: 32 characters
AuthorizationAmount Represents the amount to be authorized.
Type: Price
Yes
SellerAuthorizationNote A description for the transaction that is
displayed in emails to the buyer.
Type: xs:string
TransactionTimeout The number of minutes after which
the authorization will automatically
be closed and you will not be able to
capture funds against the authorization.
Note: The Authorize
operation always returns
the State as Pending. The
authorization remains in this
state until it is processed by
Amazon. The processing
time varies and can be
a minute or more. After
processing is complete,
Amazon will notify you of
the final processing status.
For more information, see
No Zero or integral values in multiples
of five (5, 10, 15, etc.). Set the value
to zero for synchronous mode. Set
the value to greater than zero for
asynchronous mode.
TransactionTimeout values in
synchronous mode:
Must be 0
TransactionTimeout values in
asynchronous mode:
Minimum: 5
Maximum: 1440
Default: 1440
"Synchronizing your systems
with Amazon Payments"
in the Login and Pay with
Amazon Integration Guide.
Type: xs:nonNegativeInteger
CaptureNow Indicates whether to directly capture
a specified amount against an order
reference (without needing to call
Capture and without waiting until the
order ships). The captured amount is
disbursed to your account in the next
disbursement cycle.
Note: The Amazon
Payments policy states that
you charge your buyer when
you fulfill the items in the
order. You should not collect
funds prior to fulfilling the
order.
Type: xs:boolean
No CaptureNow values:
true: The specified amount is
directly captured. You do not need
to call the Capture operation.
false: You must call the Capture
operation to capture the funds
specified in this authorization.
Default: false
SoftDescriptor The description to be shown on the
buyers payment instrument statement
if CaptureNow is set to true. The soft
descriptor sent to the payment processor
is: AMZ* <soft descriptor specified
here>.
Type: xs:string
No Default: AMZ*<SELLER_NAME>
amzn.com/pmts WA
Response elements
Name Description
AuthorizationDetails Encapsulates details about the Authorization object including the status,
amount captured, and fee charged.
Type: AuthorizationDetails
Examples
?AWSAccessKeyId=AKIAFBM3LG5JEEXAMPLE
&Action=Authorize
&AuthorizationAmount.Amount=94.50
&AuthorizationAmount.CurrencyCode=USD
&AuthorizationReferenceId=test_authorize_1
&SellerAuthorizationNote=Lorem%20ipsum
&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/
<AuthorizeResult>
<AuthorizationDetails>
<AmazonAuthorizationId>
P01-1234567-1234567-0000001
</AmazonAuthorizationId>
<AuthorizationReferenceId>test_authorize_1</AuthorizationReferenceId>
<SellerAuthorizationNote>Lorem ipsum</SellerAuthorizationNote>
<AuthorizationAmount>
<Amount>94.50</Amount>
</AuthorizationAmount>
<AuthorizationFee>
<Amount>0</Amount>
</AuthorizationFee>
<AuthorizationStatus>
<State>Pending</State>
<LastUpdateTimestamp>2012-11-03T19:10:16Z</LastUpdateTimestamp>
</AuthorizationStatus>
</AuthorizationDetails>
</AuthorizeResult>
<ResponseMetadata>
<RequestId>b4ab4bc3-c9ea-44f0-9a3d-67cccef565c6</RequestId>
</ResponseMetadata>
</AuthorizeResponse>
Related topics
GetAuthorizationDetails
CloseAuthorization
Returns the status of a particular authorization and the total amount captured on the authorization.
Description
Call the GetAuthorizationDetails operation to query the status of a particular authorization and to retrieve
information about the total amount captured on the authorization. If you received a Pending status when you called the
Authorize operation, you can call this operation to get the current status.
Request parameters
AmazonAuthorizationId The authorization identifier that was
generated by Amazon in the earlier call
to Authorize.
Type: xs:string
Yes
Response elements
Name Description
AuthorizationDetails Encapsulates details about the Authorization object including the status,
amount captured, and fee charged.
Type: AuthorizationDetails
Examples
&Action=GetAuthorizationDetails
&AmazonAuthorizationId=P01-1234567-1234567-0000001
&SignatureVersion=2
&Timestamp=2012-11-05T19%3A01%3A11Z
&Version=2013-01-01
Example response
<GetAuthorizationDetailsResponse xmlns=" https://mws.amazonservices.com/
<AmazonAuthorizationId>
P01-1234567-1234567-0000001
</AmazonAuthorizationId>
<AuthorizationReferenceId>test_authorize_1</AuthorizationReferenceId>
<SellerAuthorizationNote>Lorem ipsum</SellerAuthorizationNote>
<AuthorizationAmount>
</AuthorizationAmount>
<AuthorizationFee>
<Amount>0</Amount>
</AuthorizationFee>
<AuthorizationStatus>
<State>Open</State>
<LastUpdateTimestamp>2012-12-10T19%3A01%3A11Z</LastUpdateTimestamp>
</AuthorizationStatus>
<CreationTimestamp>2012-12-10T19%3A01%3A11Z</CreationTimestamp>
<ResponseMetadata>
</ResponseMetadata>
</GetAuthorizationDetailsResponse>
Related topics
Authorize
CloseAuthorization
Capture
Captures funds from an authorized payment instrument.
Description
Call the Capture operation to capture funds from an authorized payment instrument. To successfully capture
a payment, you must call this operation on an Authorization object before it expires, as specified by the
ExpirationTimestamp returned in response of the Authorize operation call. You must specify a capture amount, and
the amount cannot exceed the original amount that was authorized.
You can query the status of a capture request by calling the GetCaptureDetails operation.
Request parameters
to Authorize.
Type: xs:string
Yes
CaptureReferenceId The identifier for this capture
transaction that you specify. This
identifier must be unique for all your
capture transactions.
Type: xs:string
(_).
CaptureAmount The amount to capture in this
transaction.
This amount cannot exceed the original
amount that was authorized less any
previously captured amount on this
authorization.
Type: Price
Yes
SellerCaptureNote A description for the capture transaction
that is displayed in emails to the buyer.
Type: xs:string
buyers payment instrument statement.
The soft descriptor sent to the payment
processor is: AMZ* <soft descriptor
specified here>.
Type: xs:string
amzn.com/pmts WA
Response elements
Name Description
CaptureDetails Encapsulates details about the Capture object and its status.
Type: CaptureDetails
Examples
&Action=Capture
&CaptureAmount.Amount=94.50
&CaptureAmount.CurrencyCode=USD
&CaptureReferenceId=test_capture_1
&SellerCaptureNote=Lorem%20ipsum
&SignatureVersion=2
&Timestamp=2012-11-05T19%3A01%3A11Z
&Version=2013-01-01
Example response
<CaptureResponse xmlns="https://mws.amazonservices.com/schema/
<CaptureResult>
<CaptureDetails>
<AmazonCaptureId>P01-1234567-1234567-0000002</AmazonCaptureId>
<CaptureReferenceId>test_capture_1</CaptureReferenceId>
<SellerCaptureNote>Lorem ipsum</SellerCaptureNote>
<CaptureAmount>
</CaptureAmount>
<CaptureStatus>
<State>Completed</State>
</CaptureStatus>
</CaptureDetails>
</CaptureResult>
<ResponseMetadata>
</ResponseMetadata>
</CaptureResponse>
Related topics
GetCaptureDetails
GetCaptureDetails
Returns the status of a particular capture and the total amount refunded on the capture.
Description
Call the GetCaptureDetails operation to query the status of a particular capture and to retrieve information about the
total amount refunded on the capture. If you received a Pending status when you called the Capture operation, you
can call this operation to get the current status.
Request parameters
AmazonCaptureId The capture identifier that was
generated by Amazon on the earlier call
to Capture.
Type: xs:string
Yes
Response elements
Name Description
CaptureDetails Encapsulates details about the Capture object and its status.
Type: CaptureDetails
Related topics
Capture
CloseAuthorization
Closes an authorization.
Description
Call the CloseAuthorization operation to close an authorization after the total amount of the authorization has been
captured.
Request parameters
to Authorize.
Type: xs:string
Yes
ClosureReason A description for the closure that is
Type: xs:string
Response elements
Examples
&Action=CloseAuthorization
&ClosureReason=Closing%20the%20auhorization%20transaction
&SignatureVersion=2
&Timestamp=2012-12-17T19%3A01%3A11Z
&Version=2013-01-01
Example response
<CloseAuthorizationResponse xmlns="https://mws.amazonservices.com/schema/
<ResponseMetadata>
<RequestId>a9aedsd6-a10y-11t8-9a3d-67gggwd565c6</RequestId>
</ResponseMetadata>
</CloseAuthorizationResponse>
Related topics
Authorize
Refund
Refunds a previously captured amount.
Description
Call the Refund operation to refund a previously captured amount. A refund can only be requested on a capture if the
refund 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.
Request parameters
AmazonCaptureId The capture identifier that was
to Capture.
Type: xs:string
Yes
RefundReferenceId The identifier for this refund transaction
that you specify. This identifier must be
unique 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 $75
above the captured amount less the
amount already refunded on the
capture.
In the UK: the lesser of 15% or 75
above the captured amount for the
Capture object.
In Germany: the lesser of 15% or
75 above the captured amount for
the Capture object.
Type: Price
Yes
SellerRefundNote A description for the refund that is
Type: xs:string
buyers payment instrument statement.
The soft descriptor sent to the payment
amzn.com/pmts WA
processor is: AMZ* <soft descriptor
specified here>.
Type: xs:string
Response elements
Name Description
RefundDetails Encapsulates details about the Refund object and its status.
Type: RefundDetails
Examples
&Action=Refund
&AmazonCaptureId=P01-1234567-1234567-0000002
&RefundAmount.Amount=94.50
&RefundAmount.CurrencyCode=USD
&RefundReferenceId=test_refund_1
&SellerRefundNote=Lorem%20ipsum
&SignatureVersion=2
&Timestamp=2012-11-05T19%3A01%3A11Z
&Version=2013-01-01
Example response
<RefundResponse xmlns="https://mws.amazonservices.com/schema/
<RefundResult>
<RefundDetails>
<AmazonRefundId>P01-1234567-1234567-0000003</AmazonRefundId>
<RefundReferenceId>test_refund_1</RefundReferenceId>
<SellerRefundNote>Lorem ipsum</SellerRefundNote>
<RefundType>SellerInitiated</RefundType>
<RefundedAmount>
</RefundedAmount>
<FeeRefunded>
<Amount>0</Amount>
</FeeRefunded>
<RefundStatus>
<State>Completed</State>
</RefundStatus>
</RefundDetails>
</RefundResult>
<ResponseMetadata>
</ResponseMetadata>
</RefundResponse>
Related topics
GetRefundDetails
GetRefundDetails
Returns the status of a particular refund.
Description
Call the GetRefundDetails operation to query the status of a particular refund. If you received a Pending status when
you called the Refund operation, you can call this operation to get the current status.
Request parameters
AmazonRefundId The Amazon-generated identifier for
this refund transaction.
Type: xs:string
Yes
Response elements
Name Description
RefundDetails Encapsulates details about the Refund object and its status.
Type: RefundDetails
Related topics
Refund
GetServiceStatus
Returns the operational status of the Off-Amazon Payments API section.
Description
The GetServiceStatus operation returns the operational status of the Off-Amazon Payments API section of Amazon
Marketplace Web Service (Amazon MWS). Status values are GREEN, GREEN_I, YELLOW, and RED.
The GetServiceStatus operation has a maximum request quota of two requests and a restore rate of one request
every five minutes. For definitions of throttling terminology, see Throttling.
Request parameters
The GetServiceStatus operation only accepts the required request parameters. For more information about the
request parameters that are required for all Amazon MWS operations, see "Required request parameters" in the
Amazon MWS Developer Guide.
Response elements
Name Description
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 operating
with 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
?AWSAccessKeyId=AKIAEEXAMPLENGQCJLSA
&Action=GetServiceStatus
&SellerId=A135KKEKWF1J56
&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/
<GetServiceStatusResult>
<Status>GREEN</Status>
<Timestamp>2013-07-25T18:17:45.167Z</Timestamp>
</GetServiceStatusResult>
<ResponseMetadata>
<RequestId>082c41fd-2f6b-4616-a518-7db14EXAMPLE</RequestId>
</ResponseMetadata>
</GetServiceStatusResponse>
Related topics
Off-Amazon Payments Datatypes
The following datatypes are used in the request parameters and response elements of the Amazon Marketplace Web
Service (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 fee
charged.
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 an Order 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.
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.
Address
Postal 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 street address information. At lease one of AddressLine1,
AddressLine2, or AddressLine3 is required.
Type: xs:string
AddressLine2 Additional street address information, if required. At lease one of
AddressLine1, AddressLine2, or AddressLine3 is required.
Type: xs:string
Name Description
AddressLine3 Additional street address information, if required. At lease 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
AuthorizationDetails
Encapsulates 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.
Name Description
Type: xs:string
SellerAuthorizationNote A description for the authorization transaction that is displayed in
emails 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 this
Authorization object.
This list is empty if you have not requested any captures on this
authorization.
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 be
requested against the authorization. In ISO 8601 format.
Type: xs:dateTime
AuthorizationStatus Describes the current status of the authorization.
Note: The Authorize operation always returns the State
as Pending. The authorization remains in this state until it is
processed by Amazon. The processing time varies and can
be a minute or more. After processing is complete, Amazon
will notify you of the final processing status. For more
information, see "Synchronizing your systems with Amazon
Payments" in the Login and Pay with Amazon Integration
Guide.
For more information about the State and ReasonCode response
elements, see Authorization States and Reason Codes.
Type: Status
CaptureNow Indicates whether you specified a direct capture against the order
reference. The captured amount will disbursed to your account in the
next disbursement cycle.
CaptureNow values:
true: The specified amount was directly captured. You do not need
to call the Capture operation.
false: You must call the Capture operation to capture the funds
specified in this authorization.
Default: false
Type: xs:boolean
Name Description
SoftDescriptor The description to be shown on the buyers payment instrument
statement if CaptureNow was set to true. Maximum: 16 characters.
Type: xs:string
Buyer
The 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
CaptureDetails
Encapsulates 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: 32
characters.
Type: xs:string
SellerCaptureNote A description for the capture that is displayed in emails to the buyer.
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.
Name Description
Type: Price
IdList A list of AmazonRefundId identifiers that have been requested on this
Capture object.
This list is empty if you have not requested any refunds on this capture.
Type: List of Type: xs:string
CreationTimestamp The time at which the capture was created. In ISO 8601 format.
Type: xs:dateTime
CaptureStatus Represents the current status of the capture.
elements, see Capture States and Reason Codes.
Type: Status
statement. Maximum: 16 characters.
Type: xs:string
Constraint
Indicates mandatory information that is missing or incorrect in an Order Reference object.
Datatype content
The following table shows the elements of the Constraint datatype:
Name Description
ConstraintID The identifier of the constraint. For more information, see Order
Reference Constraints.
Type: xs:string
Description The description of the constraint. For more information, see Order
Reference Constraints.
Type: xs:string
Destination
Represents 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
Name Description
PhysicalDestination The address of the destination.
Type: Address
OrderReferenceAttributes
The seller-specified attributes of an Order Reference object.
Datatype content
The following table shows the elements of the OrderReferenceAttributes datatype:
Name Description Required Valid Valiues
OrderTotal Specifies the total amount of the order
represented by this order reference.
Type: OrderTotal
Yes
PlatformId Represents the unique identifier of the
seller's platform.
Type: xs:string
No The encrypted SellerId for the account
that is associated with the platform or
plugin being used by the seller.
SellerNote Represents a description of the order
that is displayed in emails to the buyer.
Type: xs:string
SellerOrderAttributes Provides more context about the
order that is represented by this order
reference.
Type: SellerOrderAttributes
No
OrderReferenceDetails
Encapsulates 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 Button
widget.
Type: xs:string
Buyer Provides details about the buyer. This information will only be returned
after you confirm the order reference.
Type: Buyer
OrderTotal Represents the total amount for this Order Reference object. This
response element is not returned if you have not set it by calling the
SetOrderReferenceDetails operation.
Type: OrderTotal
Name Description
SellerNote Represents a description of the order that is displayed in emails to the
buyer. This response element is not returned if you have not set it by
calling the SetOrderReferenceDetails operation. Maximum: 1024
characters.
Type: xs:string
Destination Represents the address selected by the buyer through the AddressBook
widget.
Complete buyer information will only be returned after you
have confirmed the order reference. Until then, only the City,
StateOrRegion, PostalCode, and CountryCode 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 order
reference. This response element is not returned if you have not set it by
calling the SetOrderReferenceDetails operation.
Type: SellerOrderAttributes
OrderReferenceStatus Indicates the current status of the order reference.
elements, see Order Reference States and Reason Codes.
Type: OrderReferenceStatus
Constraints A list of constraints that indicates mandatory information that is
missing or incorrect. The presence of constraints indicates that the order
reference is not ready to be confirmed and cannot be used for payment
operations.
For more information, see Order Reference Constraints.
Type: List of Constraint
CreationTimestamp The date and time, in UTC, when the order reference was created. In
ISO 8601 format.
Type: xs:dateTime
ExpirationTimestamp The date and time, in UTC, when the order reference will expire and
will no longer be valid for authorization requests. In ISO 8601 format.
Note: An order reference (if confirmed) expires 180 days
after it is created. It will be canceled by Amazon if it is not
confirmed within three hours of its creation.
Type: xs:dateTime
OrderReferenceStatus
Indicates 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 more
information, see Order Reference States and Reason Codes.
Type: xs:string
LastUpdateTimestamp A timestamp that indicates the time when the order reference state was
last updated. In ISO 8601 format. Optional if the order reference is in
the Draft state.
Type: xs:dateTime
ReasonCode Optional if the order reference is in the Draft state. For more
information, see Order Reference States and Reason Codes.
Type: xs:string
ReasonDescription An optional description of the order reference status.
Type: xs:string
OrderTotal
The 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 4217
format.
Type: xs:string
Yes The currency code is formatted based
on the ISO 4217 standard. The number
of decimal places must be appropriate
for the currency code specified. A
period is the only valid decimal
separator for the amount value.
Amount The currency amount.
Type: xs:string
Yes
Price
Currency type and amount.
Datatype content
The following table shows the elements of the Price datatype:
CurrencyCode Three-digit currency code. In ISO 4217
format.
Type: xs:string
Yes The currency code is formatted based
on the ISO 4217 standard. The number
of decimal places must be appropriate
for the currency code specified. A
period is the only valid decimal
separator for the amount value.
Amount The currency amount.
Type: xs:string
Yes Minimum: 1 character
RefundDetails
Encapsulates 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: 32
characters.
Type: xs:string
SellerRefundNote A description for the refund that is displayed in emails to the buyer.
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.
Type: xs:dateTime
RefundStatus Represents the status of the refund request.
Note: The Refund operation always returns the State as
Pending. The Refund object remains in this state until it is
processed by Amazon. The refund processing time varies and
can be several hours. After processing is complete, Amazon
will notify you of the final processing status. For more
information, see "Synchronizing your systems with Amazon
Payments" in the Login and Pay with Amazon Integration
Guide.
elements, see Refund States and Reason Codes.
Type: Status
Name Description
statement. Maximum: 16 characters.
Type: xs:string
SellerOrderAttributes
Provides 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 this
order. This is displayed to the buyer in
their e-mails and transaction history on
the Amazon Payments website.
Type: xs:string
No Amazon recommends that you use only
(_).
StoreName The identifier of the store from where
the order was placed. This overrides the
default value in Seller Central under
Settings > Account Settings. It is
displayed to the buyer in their emails
and transaction history on the Amazon
Payments website.
Type: xs:string
No
CustomInformation Any additional information you wish to
include with this order reference.
Type: xs:string
No
Status
Indicates 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, or
Refund object is in. For more information, see Authorization States and
Reason Codes, Capture States and Reason Codes, or Refund States and
Reason Codes.
State values:
Pending
Open
Declined
Closed
Name Description
Completed
Type: xs:string
LastUpdateTimestamp A timestamp that indicates the time when the authorization, capture, or
refund state was last updated. In ISO 8601 format.
Type: xs:dateTime
ReasonCode The reason the Authorization object, Capture object, or Refund object is
in the current state. For more information, see Authorization States and
Reason Codes, Capture States and Reason Codes, or Refund States and
Reason Codes.
Type: xs:string
ReasonDescription An optional description of the authorization, capture, or refund status.
Type: xs:string
Order Reference Constraints
An Order Reference object is only eligible for payment authorization and capture after you confirm the order reference
by calling the ConfirmOrderReference operation. The ConfirmOrderReference operation call will succeed only if
there are no constraints on the Order Reference object. Constraints indicate that important order reference information
is either missing or invalid.
You can take corrective actions to fix the order reference and remove the constraints before calling the
ConfirmOrderReference operation. The following table lists the constraints and corrective action you must take to
remove the constraint:
ConstraintId Description Corrective Action
ShippingAddressNotSet The buyer has not selected a shipping address
from the Amazon AddressBook widget.
Display the Amazon AddressBook widget to
the buyer to collect shipping information.
PaymentPlanNotSet The buyer has not set a payment method for the
given order reference.
Display the Amazon Wallet widget to the
buyer to collect payment information.
AmountNotSet You have not set the amount for the order
reference.
Call the SetOrderReferenceDetails
operation and specify the order amount in the
OrderTotal request parameter.
PaymentMethodNotAllowed The payment method selected by the buyer is
not allowed for this order reference.
Display the Amazon Wallet widget and
request the buyer to select a different payment
method.
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 the
reasons why an Order Reference object can end up in a state:
State Description Allowed Operations Reason Codes
Draft An Order Reference object is
in the Draft state prior to be
being confirmed by calling
the ConfirmOrderReference
operation.
Open An Order Reference object
moves to the Open state after
it is confirmed by calling the
operation. Authorizations can only
be requested on an order reference
that is in the Open state.
CancelOrderReference (only if
there are no Pending, Completed,
or Closed captures against the
Order Reference object)
CloseOrderReference
Authorize
Suspended An Order Reference object moves
to the Suspended state when
there are problems with the
payment method that is preventing
Amazon from processing the
authorizations. You cannot request
new authorizations when the order
reference is in the Suspended
state. However, you still can
capture existing authorizations and
apply refunds to captures.
You should request another form
of payment from the buyer if the
Order Reference object moves to
the Suspended state.
CancelOrderReference (only if
there are no Pending, Completed,
or Closed captures against the
Order Reference object)
CloseOrderReference
InvalidPaymentMethod. There
were problems with the payment
method.
Canceled The Order Reference object
can be canceled by calling
the CancelOrderReference
operation or it can be canceled by
Amazon.
GetOrderReferenceDetails SellerCanceled. You have
explicitly canceled the order
reference by calling the
operation. You can specify the
You can only cancel an order if
no money has been captured or
charged on the order reference.
Any pending authorizations will
be canceled and no new payment
operations will be allowed in the
future.
reason for the cancelation in the
CancelationReason request
parameter.
Stale. You did not confirm
the order reference by calling
the ConfirmOrderReference
operation within the allowed
period of 3 hours.
AmazonCanceled. Amazon has
canceled the order reference.
Closed The Order Reference object
can be closed by calling the
CloseOrderReference operation
or it can be closed by Amazon.
You cannot request new
authorizations when the order
reference is in the Closed
state. Captures on existing
authorizations are still allowed.
Refunds on captures are also still
allowed.
GetOrderReferenceDetails Expired. You can only authorize
funds on the buyers payment
instrument up to 180 days after
the order reference is created.
After this, Amazon will mark the
order reference as closed and new
authorizations will not be allowed.
MaxAmountCharged. You are
allowed to capture the following
amounts before the order reference
will be closed by Amazon:
In the US: up to 15% or $75
(whichever is less) above the
order reference amount.
In the UK: up to 15% or 75
In Germany: up to 15% or 75
MaxAuthorizationsCaptured.
You have fully or partially
captured 10 authorizations. After
this, the order reference will be
closed by Amazon.
AmazonClosed. Amazon has
closed the order reference due to
a failed internal validation or due
to an A-to-z claim being decided
against you.
SellerClosed. You have
explicitly closed the order
reference by calling the
CloseOrderReference operation.
You can specify the reason for
closure in the ClosureReason
request parameter of the
CloseOrderReference 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 with
a TransactionTimeout value equal to zero. You will only receive an Open or Declined status in the initial
response.
The following table describes each Authorization object state in detail, the allowed operations on a state, and the
reasons why an authorization can end up in a state.
Pending All Authorization objects are in
the Pending state for 30 seconds
after you submit the Authorize
request. This cannot be simulated
in synchronous mode.
CloseAuthorization
Open In asynchronous mode, the
Authorization object moves to
the Open state after remaining
in the Pending state for 30
seconds. In synchronous mode, the
Authorization object immediately
moves to the Open state.
Capture
CloseAuthorization
Declined The authorization has been
declined by Amazon.
GetAuthorizationDetails InvalidPaymentMethod. There
were problems with the payment
method. You should contact
your buyer and have them update
their payment method using the
Amazon Payments web site.
AmazonRejected. Amazon has
rejected the authorization. You
should only retry the authorization
if the order reference is in the
Open state.
ProcessingFailure. Amazon could
not process the transaction due to
an internal processing error. You
should only retry the authorization
if the order reference is in the
Open state.
TransactionTimedOut. In
asynchronous mode, indicates
that the Authorize operation
call was not processed within
the default timeout period of
24 hours or within the time
period specified by you in the
TransactionTimeout request
parameter. In synchronous
mode, indicates that Amazon
could not process your request
within 6-8 seconds. If you are
observing a high number of
declines due to this reason code,
try adjusting the timeout value in
asynchronous mode, or consider
using asynchronous mode if you
are using synchronous mode. An
alternate approach for handling
this error in synchronous mode
is to retry the transaction in
asynchronous mode.
Closed The authorization can be closed by
calling the CloseAuthorization
operation, by calling the
operation, or it can be closed by
Amazon.
You cannot request captures
against an authorization that is in
the Closed state.
In the event of a partial capture,
the remaining amount will
be credited back to the order
reference.
GetAuthorizationDetails ExpiredUnused. The
authorization has been in the Open
state for 30 days (two days for
Sandbox) and you did not submit
any captures against it.
MaxCapturesProcessed. You
have already captured the full
amount of the authorization.
Amazon allows only one capture
per authorization.
closed the authorization object due
to problems with your account.
OrderReferenceCanceled. The
order reference was canceled
causing all open authorizations
to be canceled. You can call the
operation and check the
ReasonCode response element for
the cancelation reason.
SellerClosed. You have explicitly
closed the authorization using the
CloseAuthorization operation.
You can specify the reason for
the closure in the ClosureReason
request 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 a
Capture object can end up in a state.
Pending A Capture object is in the Pending
Amazon.
GetCaptureDetails
Declined You must submit a capture
against an authorization within 30
days (two days for the Sandbox
environment). However, we
strongly recommend requesting
a capture within 7 days of
authorization.
If the capture is declined. you can
still request a new authorization
and capture if the order reference
is in the Open state.
GetCaptureDetails AmazonRejected. Amazon
has rejected the capture. You
should only retry the capture if the
authorization is in the Open state.
ProcessingFailure. Amazon could
not process the transaction due to
an internal processing error. You
should only retry the capture if the
authorization is in the Open state.
Otherwise, you should request a
new authorization and then call
Capture on it.
Completed The Capture object request has
been processed and funds will be
moved to your account in the next
disbursement cycle.
GetCaptureDetails
Refund
Closed When the Capture object is move
to the Closed state, you cannot
request refunds against it.
GetCaptureDetails MaxAmountRefunded. You have
already refunded the following
amounts:
In the US: up to 15% or $75
captured amount.
In the UK: up to 15% or 75
captured amount.
In Germany: up to 15% or 75
captured amount.
MaxRefundsProcessed. You have
already submitted 10 refunds for
this Capture object.
closed the capture due to a
problem with your account or with
the 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 a
Refund object can end up in a state.
Pending A Refund object is in the Pending
Amazon.
GetRefundDetails
Declined Amazon has declined the refund
because the maximum amount has
been refunded on the capture.
GetRefundDetails AmazonRejected. Amazon has
rejected the refund. You should
issue a refund to the buyer in an
alternate manner (for example, a
gift card or store credit).
ProcessingFailure. Amazon
could not process the transaction
due to an internal processing
error or because the buyer has
already received a refund from
an A-to-z claim or a charge back.
You should only retry the refund
if the Capture object is in the
Completed state. Otherwise, you
should refund the buyer in an
alternative way (for example, a
store credit or a check).
Completed The refund request has been
processed and funds will be
returned to the buyer.
GetRefundDetails
Error codes
The following table explains the source for the various error codes that the Off-Amazon Payments API section can
return. For descriptions of error codes that are common to all MWS API sections, see the Amazon MWS Developer
Guide.
Error code Description
CaptureNotRefundable You have attempted a refund on a Capture object that is in a state where
a refund is not allowed.
ConstraintsExist The Order Reference object that you submitted in this request has
constraints and cannot be confirmed. Consult the error message for a list
of the constraints on the Order Reference object.
DuplicateRequest A request with the supplied AuthorizationReferenceId,
CaptureReferenceId, or RefundReferenceId has already been
processed with different parameters.
InternalServerError There was an unknown error in the service.
InvalidAccountStatus Your account is not in an appropriate state to execute this request. For
example, your account has been suspended, you have not completed
registration, etc.
InvalidAddress You have provided an invalid section name or version in the request.
InvalidAddressConsentToken The AddressConsentToken is not valid. Ensure that the token has not
expired and that it belongs to the buyer on this contract.
InvalidAuthorizationStatus You have attempted to capture or close an authorization for an
Authorization object that is in a state where a capture or close is not
allowed.
InvalidCancelAttempt The Order Reference object that you submitted in this request cannot be
canceled for the supplied reason.
InvalidCloseAttempt The Order Reference object or Authorization object that you submitted
in this request cannot be closed for the supplied reason.
InvalidOrderReferenceId The order reference identifier that you submitted in this request is
invalid.
InvalidOrderReferenceStatus You have attempted to call an operation on an Order Reference object
that is in a state where that operation is not allowed.
InvalidSandboxSimulationSpecified You have attempted an invalid operation for the sandbox environment.
Consult the error message for more information.
InvalidSellerId The seller identifier that you have provided is invalid.
InvalidTransactionId The transaction identifier that you submitted in this request is invalid.
MissingAuthenticationToken The request that you sent to the server does not have a valid signature.
OrderReferenceNotModifiable The Order Reference object that you submitted in this request is
confirmed and cannot be modified
RequestThrottled Your request has been rejected because the request rate is higher than
the allocated throttling limits.
ServiceUnavailable The service is temporarily unavailable. Please try again later.
TransactionAmountExceeded You have attempted to authorize an Order Reference object for an
amount that exceeds the maximum authorization amount allowed.
TransactionAmountExceeded You have attempted to capture an Authorization object or refund a
Capture object for an amount that exceeds the maximum capture or
refund amount allowed.
Error code Description
TransactionCountExceeded The number of authorizations, captures, or refunds has already exceeded
the maximum allowed limit.
UnauthorizedAccess The seller account <SellerId> is not authorized to execute this request.
Client library updates
The following tables describe the most recent updates to the Off-Amazon Payments API section client libraries:
PHP
Release date Description
2013-05-29 Initial release.
C#
Java

M Ws Off Amazon Payment Sap I Reference

Hochgeladen von

Dokumentinformationen

Originaltitel

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

M Ws Off Amazon Payment Sap I Reference

Hochgeladen von

Copyright:

Verfügbare Formate

Amazon Marketplace Web Service

Off-Amazon Payments API Section

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

Das könnte Ihnen auch gefallen