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:

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

There is a maximum of 10 Refunds per Capture. You call the GetRefundDetails operation to query the status of a refund.

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 and for a complete explanation of throttling, see Throttling: Limits to how often you can submit requests in the Amazon MWS Developer Guide.

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.

Parameter Name

Required

Type

Description

AmazonCaptureId

Yes

xs:string

The capture identifier that was generated by Amazon in the earlier call to Capture.

RefundReferenceId

Yes

xs:string

The identifier for this refund transaction that you specify. This identifier must be unique for all your refund transactions.

Amazon recommends that you use only the following characters:

  • lowercase a-z
  • uppercase A-Z
  • numbers 0-9
  • dash (-)
  • underscore (_)

Maximum: 32 characters

RefundAmount

Yes

Price

The amount to refund.

This amount cannot exceed:

  • US: the lesser of 15% or $75 above the captured amount less the amount already refunded on the capture.
  • UK: the lesser of 15% or £75 above the captured amount for the Capture object.
  • DE: the lesser of 15% or €75 above the captured amount for the Capture object.

Maximum values:

  • US: $150,000
  • UK: £150,000
  • DE: €150,000

SellerRefundNote

No

xs:string

A description for the refund that is displayed in emails to the buyer.

Maximum: 255 characters

SoftDescriptor

No

xs:string

The description to be shown on the buyer's payment instrument statement. The soft descriptor sent to the payment processor is: “AMZ* <soft descriptor specified here>”.

Default: “AMZ*<SELLER_NAME> Amazon Pay”

Maximum: 16 characters

Response Elements

Element Name

Description

RefundDetails

Encapsulates details about the Refund object and its status.

Type: RefundDetails

Examples

Example Query Request

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

  AWSAccessKeyId=AKIAFBM3LG5JEEXAMPLE
  &Action=Refund
  &AmazonCaptureId=P01-1234567-1234567-0000002
  &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>Pending</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>

Related Topics


Copyright © 2009-2018 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.