Manage refunds
[Step 5 of 7] There is no time limit to initiate a refund. You can either issue refunds using Create Refund, or you can manually issue refunds through Seller Central, the account management site for Amazon Pay merchants. Amazon Pay will notify the buyer after a refund has been successfully processed. See buyer communication for more info.
In this step, you will add the ability to issue refunds via API. At the end of this step, you will be able to issue full or partial refunds and check on refund status.
1. Issue a refund
Create Refund to issue a full or partial refund for a successful Charge. You may (at your discretion) also choose to overcompensate the buyer, and refund more than the original Charge amount by either 15% or 75 USD/GBP/EUR or 8,400 YEN (whichever is less).
Request
Request body
{
"chargeId": "S01-5105180-3221187-C056351",
"refundAmount": {
"amount": "14.00",
"currencyCode": "USD"
},
"softDescriptor": "Descriptor"
}
Request parameters
| Name
|
Location
|
Description
|
| x-amz-pay-idempotency-key (required) Type: string |
Header
|
Idempotency key to safely retry requests
|
| chargeId (required) Type: string |
Body
|
Charge identifier
|
| refundAmount (required) Type: price |
Body
|
Amount to be refunded. Refund amount can be either 15% or 75 USD/GBP/EUR and 8400 JPY (whichever is less) above the captured amount Maximum value: 150,000 USD/GBP/EUR and 10,000,000 JPY |
| softDescriptor Type: string |
Body
|
The description is shown on the buyer payment instrument (such as bank) statement Default: "AMZ* <MerchantStoreName> amzn.com/pmts" Max length: 16 characters/bytes |
Response
{
"refundId": "S01-5105180-3221187-R022311",
"chargeId": "S01-5105180-3221187-C056351",
"refundAmount": {
"amount": "14.00",
"currencyCode": "USD"
},
"softDescriptor": "Descriptor",
"creationTimestamp": "20190714T155300Z",
"statusDetails": {
"state": "RefundInitiated",
"reasonCode": null,
"reasonDescription": null,
"lastUpdatedTimestamp": "20190714T155300Z"
},
"releaseEnvironment": "Sandbox"
}
2. Check refund status
Get Refund to check Refund status. Amazon Pay processes refunds asynchronously. Either set up Instant Payment Notifications (IPNs), or implement a polling mechanism to query the Get Refund API for updates. See asynchronous processing for more info.
Refund state explanation
| Refund status
|
Description
|
| RefundInitiated
|
Refund is still pending processing
|
| Refunded
|
Refund was successful
|
| Declined
|
Refund was declined. Check the reason code for more information: AmazonRejected - Amazon has rejected the refund, potentially due to a negative balance in your merchant account. To resolve this, you should repay the negative seller balance (NSB) to Amazon, then attempt the refund again or 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 because of an internal processing error, or because the buyer has already received a refund from an A-to-z claim, or a chargeback. 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) |
Request
curl "https://pay-api.amazon.com/:version/refunds/:refundId" \
-X GET
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"
-H "x-amz-pay-date:20201012T235046Z"
Request parameters
| Name
|
Location
|
Description
|
| refundId (required) Type: string |
Path Parameter
|
Refund identifier
|
Response
{
"refundId": "S01-5105180-3221187-R022311",
"chargeId": "S01-5105180-3221187-C056351",
"refundAmount": {
"amount": "14.00",
"currencyCode": "USD"
},
"softDescriptor": "Descriptor",
"creationTimestamp": "20190714T155300Z",
"statusDetails": {
"state": "Refunded",
"reasonCode": null,
"reasonDescription": null,
"lastUpdatedTimestamp": "20190714T155300Z"
},
"releaseEnvironment": "Sandbox"
}