Common Request Parameters

Each action in the API has its own specific set of parameters, but there is also a set of parameters that all actions use. This section describes those input parameters.

You only need to add these parameters in REST requests. SOAP requests include them by default.

The following table describes parameters that can be used in all requests.

Parameter Description Required

Action

The API operation, for example, Settle or Refund.

Type: String:

Default: None

Constraint: Must be a valid operation such as Cancel, Refund, and so on.

Yes

AWSAccessKeyId

A string, distributed by Amazon FPS when you sign up to be a developer, that uniquely identifies the caller.

Type: String

Default: None

Yes

Signature

A value calculated using the request parameters and a SHA256 (preferred) or SHA1 HMAC encryption algorithm.

Type: String

Default: None

Yes

SignatureVersion

A value that specifies the Signature format.

Type: Integer

Default: None

Valid Values: 1 | 2

	Important
	If you are currently using signature version 1, you must migrate to signature version 2. Please see Appendix: Moving your Application to Signature Version 2.

Yes

SignatureMethod

A value that specifies the signing method.

Type: String

Default: None

Valid Values: HmacSHA256 (preferred) and HmacSHA1.

Yes

Timestamp

A date-time value that marks the day and time the request was sent. Requests expire after a certain length of time to prevent malicious users from capturing requests and resubmitting them at a later time.

Type: dateTime, for example, 2008-09-18T13:00:01Z

Default: None

Yes

Version

The version number of the WSDL to use in processing the request. Version numbers are dates, such as 2008-09-17. For a list of version numbers, go to the Amazon Resource Center at http://aws.amazon.com/resources.

Type: String

Default: None

Yes