Refund | Amazon Pay EU

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 15% or 75 USD/GBP/EUR (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.

This API call is idempotent. If called multiple times, with unchanged parameters (including RefundReferenceId), the same result is produced.

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 This identifier is defined by you and must be unique for every single API request, unless you plan to leverage the API idempotency.

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 15% or 75 USD/GBP/EUR (whichever is less) above the captured amount.

Maximum values: 150,000 USD/GBP/EUR
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> amzn.com/pmts"

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=EUR
&RefundReferenceId=test_refund_0001
&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_0001</RefundReferenceId>
      <SellerRefundNote>Lorem ipsum</SellerRefundNote>
      <RefundType>SellerInitiated</RefundType>
      <RefundedAmount>
        <CurrencyCode>EUR</CurrencyCode>
        <Amount>94.50</Amount>
      </RefundedAmount>
      <FeeRefunded>
        <CurrencyCode>EUR</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>