``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); $payload = array( 'chargeId' => 'S01-5105180-3221187-C056351', 'refundAmount' => array( 'amount' => '14.00', 'currencyCode' => 'USD' ), 'softDescriptor' => 'Descriptor' ); $headers = array('x-amz-pay-Idempotency-Key' => uniqid()); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->createRefund($payload, $headers); if ($result['status'] === 201) { $response = json_decode($result['response'], true); $refundState = $response['statusDetails']['state']; $refundId = $response['refundId']; } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore.Refund; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Types; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); } public void CreateRefund(string chargeId) { // prepare the request var request = new CreateRefundRequest(chargeId, 14.00M, Currency.USD); // send the request RefundResponse result = client.CreateRefund(request); // check if API call was successful if (!result.Success) { // do something, e.g. throw an error } } } ```

``` import com.amazon.pay.api.AmazonPayResponse; import com.amazon.pay.api.PayConfiguration; import com.amazon.pay.api.WebstoreClient; import com.amazon.pay.api.exceptions.AmazonPayClientException; import com.amazon.pay.api.types.Region; import org.json.JSONObject; // for generating an idempotency key import java.util.HashMap; import java.util.Map; import java.util.UUID; public void sample() { PayConfiguration payConfiguration = null; try { payConfiguration = new PayConfiguration() .setPublicKeyId("YOUR_PUBLIC_KEY_ID") .setRegion(Region.YOUR_REGION_CODE) .setPrivateKey("YOUR_PRIVATE_KEY") .setAlgorithm("AMZN-PAY-RSASSA-PSS-V2"); WebstoreClient webstoreClient = new WebstoreClient(payConfiguration); AmazonPayResponse response = null; JSONObject payload = new JSONObject(); JSONObject refundAmount = new JSONObject(); refundAmount.put("amount", "14.00"); refundAmount.put("currencyCode", "USD"); payload.put("chargeId", "S01-5105180-3221187-C056351"); payload.put("refundAmount", refundAmount); payload.put("softDescriptor", "Descriptor"); Map header = new HashMap(); header.put("x-amz-pay-idempotency-key", UUID.randomUUID().toString().replace("-", "")); response = webstoreClient.createRefund(payload,header); } catch (AmazonPayClientException e) { e.printStackTrace(); } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const uuidv4 = require('uuid/v4'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const payload = { chargeId: 'S01-5105180-3221187-C056351', refundAmount: { amount: '14.00', currencyCode: 'USD' }, softDescriptor: 'Descriptor' }; const headers = { 'x-amz-pay-idempotency-key': uuidv4().toString().replace(/-/g, '') }; const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.createRefund(payload, headers); response.then(function (result) { console.log(result.data); }).catch(err => { console.log(err); }); ```

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'sandbox' => true, 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); $payload = array( 'chargeId' => 'S01-5105180-3221187-C056351', 'refundAmount' => array( 'amount' => '14.00', 'currencyCode' => 'USD' ), 'softDescriptor' => 'Descriptor' ); $headers = array('x-amz-pay-Idempotency-Key' => uniqid()); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->createRefund($payload, $headers); if ($result['status'] === 201) { $response = json_decode($result['response'], true); $refundState = $response['statusDetails']['state']; $refundId = $response['refundId']; } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore.Refund; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Types; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, environment: Environment.Sandbox, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); } public void CreateRefund(string chargeId) { // prepare the request var request = new CreateRefundRequest(chargeId, 14.00M, Currency.USD); // send the request RefundResponse result = client.CreateRefund(request); // check if API call was successful if (!result.Success) { // do something, e.g. throw an error } } } ```

``` import com.amazon.pay.api.AmazonPayResponse; import com.amazon.pay.api.PayConfiguration; import com.amazon.pay.api.WebstoreClient; import com.amazon.pay.api.exceptions.AmazonPayClientException; import com.amazon.pay.api.types.Environment; import com.amazon.pay.api.types.Region; import org.json.JSONObject; // for generating an idempotency key import java.util.HashMap; import java.util.Map; import java.util.UUID; public void sample() { PayConfiguration payConfiguration = null; try { payConfiguration = new PayConfiguration() .setPublicKeyId("YOUR_PUBLIC_KEY_ID") .setRegion(Region.YOUR_REGION_CODE) .setPrivateKey("YOUR_PRIVATE_KEY") .setEnvironment(Environment.SANDBOX) .setAlgorithm("AMZN-PAY-RSASSA-PSS-V2"); WebstoreClient webstoreClient = new WebstoreClient(payConfiguration); AmazonPayResponse response = null; JSONObject payload = new JSONObject(); JSONObject refundAmount = new JSONObject(); refundAmount.put("amount", "14.00"); refundAmount.put("currencyCode", "USD"); payload.put("chargeId", "S01-5105180-3221187-C056351"); payload.put("refundAmount", refundAmount); payload.put("softDescriptor", "Descriptor"); Map header = new HashMap(); header.put("x-amz-pay-idempotency-key", UUID.randomUUID().toString().replace("-", "")); response = webstoreClient.createRefund(payload,header); } catch (AmazonPayClientException e) { e.printStackTrace(); } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const uuidv4 = require('uuid/v4'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', sandbox: true, algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const payload = { chargeId: 'S01-5105180-3221187-C056351', refundAmount: { amount: '14.00', currencyCode: 'USD' }, softDescriptor: 'Descriptor' }; const headers = { 'x-amz-pay-idempotency-key': uuidv4().toString().replace(/-/g, '') }; const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.createRefund(payload, headers); response.then(function (result) { console.log(result.data); }).catch(err => { console.log(err); }); ```


curl "https://pay-api.amazon.com/:environment/:version/refunds/:refundId" \ 

-X GET

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->getRefund('S01-5105180-3221187-R022311'); if ($result['status'] === 200) { $response = json_decode($result['response'], true); $chargeState = $response['statusDetails']['state']; } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Refund; using Amazon.Pay.API.WebStore.Types; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); } public void GetRefund(string refundId) { // send the request RefundResponse result = client.GetRefund(refundId); // check if API call was successful if (!result.Success) { // handle the API error (use Status field to get the numeric error code) } // do something with the result, for instance: string refundState = result.StatusDetails.State; } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.getRefund('S01-5105180-3221187-R022311'); ```

``` 'YOUR_PUBLIC_KEY_ID', 'private_key' => 'keys/private.pem', // Path to RSA Private Key (or a string representation) 'region' => 'YOUR_REGION_CODE', 'sandbox' => true, 'algorithm' => 'AMZN-PAY-RSASSA-PSS-V2' ); try { $client = new Amazon\Pay\API\Client($amazonpay_config); $result = $client->getRefund('S01-5105180-3221187-R022311'); if ($result['status'] === 200) { $response = json_decode($result['response'], true); $chargeState = $response['statusDetails']['state']; } else { // check the error echo 'status=' . $result['status'] . '; response=' . $result['response']; } } catch (Exception $e) { // handle the exception echo $e; } ?> ```

``` using Amazon.Pay.API.Types; using Amazon.Pay.API.WebStore; using Amazon.Pay.API.WebStore.Refund; using Amazon.Pay.API.WebStore.Types; public class Sample { public WebStoreClient InitiateClient() { // set up config var payConfiguration = new ApiConfiguration ( region: Region.YOUR_REGION_CODE, environment: Environment.Sandbox, publicKeyId: "YOUR_PUBLIC_KEY_ID", privateKey: "PATH_OR_CONTENT_OF_YOUR_PRIVATE_KEY", algorithm: AmazonSignatureAlgorithm.V2 ); // init API client var client = new WebStoreClient(payConfiguration); } public void GetRefund(string refundId) { // send the request RefundResponse result = client.GetRefund(refundId); // check if API call was successful if (!result.Success) { // handle the API error (use Status field to get the numeric error code) } // do something with the result, for instance: string refundState = result.StatusDetails.State; } } ```

```html const fs = require('fs'); const Client = require('@amazonpay/amazon-pay-api-sdk-nodejs'); const config = { publicKeyId: 'YOUR_PUBLIC_KEY_ID', privateKey: fs.readFileSync('tst/private.pem'), region: 'YOUR_REGION_CODE', sandbox: true, algorithm: 'AMZN-PAY-RSASSA-PSS-V2' }; const testPayClient = new Client.WebStoreClient(config); const response = testPayClient.getRefund('S01-5105180-3221187-R022311'); ```

Parameter	Description
refundId Type: string	Refund identifier
chargeId Type: string	Charge identifier
refundAmount Type: price	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	Description shown on the buyer payment instrument statement Do not store sensitive data about the buyer or the transaction in this field. Sensitive data includes, but is not limited to: government-issued identification, bank account numbers, or credit card numbers The soft descriptor sent to the payment processor is: "AMZ* <soft descriptor here>" Default: "AMZ*<SELLER_NAME> pay.amazon.com" Max length: 16 characters/bytes
creationTimestamp Type: dateTime	UTC date and time when the refund was created in ISO 8601 format
statusDetails Type: statusDetails	State of the refund object
releaseEnvironment Type: string	The environment the Refund object was created in (either Sandbox or Live)

Parameter	Description
amount Type: string	Transaction amount
currencyCode Type: string	Transaction currency code in ISO 4217 format Example: USD

Parameter	Description
state Type: string	Current object state
reasonCode Type: string	Reason code for current state
reasonDescription Type: string	An optional description of the refund state
lastUpdatedTimestamp Type: dateTime	UTC date and time when the state was created in ISO 8601 format

State	Description	Reason code
RefundInitiated	A Refund object is in Pending state until it is processed by Amazon Allowed operation: GET Refund	-
Declined	Amazon has declined the refund because maximum amount has been refunded or there was some other issue Allowed operation: GET Refund	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)
Refunded	Refund request has been processed and funds will be refunded to the buyer Allowed operation: GET Refund	-

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

HTTP status code	Reason code	Description
400 BAD_REQUEST	TransactionAmountExceeded	You've exceeded the maximum refund amount allowed for this Refund
422 UNPROCESSABLE_ENTITY	InvalidChargeStatus	You tried to call a Refund operation on a Charge that is not in a Completed state. Check the Charge status for more information
422 UNPROCESSABLE_ENTITY	TransactionCountExceeded	You've exceeded the maximum limit of 10 Refunds per Charge
422 UNPROCESSABLE_ENTITY	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)
500 INTERNAL_SERVER_ERROR	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 Charge object is in the Captured state. Otherwise, you should refund the buyer in an alternative way (for example, a store credit or a check)