AWS Documentation » Amazon Flexible Payments Service » Advanced Quick Start » Co-Branded Service API Reference » Common Parameters	« Previous Next »
	Did this page help you? Yes \| No \| Tell us about it...

Common Parameters

The following parameters are common to all Co-Branded service API requests.

Request Parameters

Name	Description	Required
`callerKey`	AWS Access Key ID of the developer. You can obtain this value from the AWS Access Identifiers page on the AWS website (http://aws.amazon.com). Type: String Default: None	Yes
`cobrandingStyle`	Specifies the co-branding type on Amazon FPS payment authorization pages. Amazon FPS is phasing out support for the banner type, so we suggest you change your co-branding to the logo type. For more information, see Co-Branding Styles. Type: String Default: `logo` Valid Values: `banner` \| `logo`	No
`cobrandingUrl`	Allows you to specify a co-branding URL dynamically. It specifies the URL of your company's logo. Type: String Default: None Constraint: This URL should point to a co-branding image that is not larger than 215 (w) x 40 (h) pixels in a secure HTTP server.	No
`pipelineName`	The kind of token you are creating. Type: String Default: None Valid Values: SingleUse \| MultiUse \| Recurring \| Recipient \| SetupPrepaid \| SetupPostpaid \| EditToken	Yes
`returnURL`	Specifies the URL on your website that the person (typically the buyer) is redirected to after completing the CBUI web pages. In addition to the URL, the redirect URI includes the following: Parameters appended to the `returnURL` in the URI Status of the request The installed token The `Signature` Type: URL Default: None	Yes
`signature`	A value calculated using the request parameters and a SHA-1 HMAC encryption algorithm to make sure the request parameters and values were not altered during the request's or response's travel across the Internet. For more information, see Working with Signatures. Type: String Default: None	Yes
`signatureVersion`	`2` Important The previous method for signing (signature version 1) was deprecated on November 3rd, 2009, and as of 10 February, 2011 it is no longer supported. Whenever you sign a request with your access keys, you must now use signature version 2.	Yes
`signatureMethod`	`HmacSHA256` (preferred) or `HmacSHA1`	Yes
`version`	The version of the API to use. Always set to `2009-01-09`. Type: String	Yes
`websiteDescription`	Human readable text to describe your website. It is used on the payment authorization pages for messaging only. For instance, a message such as "Click here to return to <websiteDescription> website" can appear on the page. Type: String Default: None	No

Co-Branding Styles

Co-branding refers to using your brand along with Amazon's on the CBUI pages. The CBUI offers the following co-branding styles.

Banner—Your logo appears in the upper left corner of the CBUI page and the Amazon Payments logo appears right below your logo on the right hand side. Amazon is phasing out support for the banner type in favor of the logo type.
Logo—Your logo appears on the upper left corner of the CBUI page, followed by a checkout cart breadcrumb in the middle, followed by the Amazon Payments logo, as shown.
This is the default behavior.

The following figure shows an example of banner co-branding.

The following figure shows an example of logo co-branding.

Response Parameters

The following table lists the parameters common to all Co-Branded service API responses.

Name	Description
`certificateUrl`	A url specifying the location of the certificate used for signing the response. Type: String Max Size: 1024 Bytes
`Signature`	Amazon FPS calculates the `Signature` using all the parameters in the `returnURL`. We recommend that you calculate the return URL's `Signature` using the same method that you used to calculate the `Signature` for your signed URL. This is to ensure that you are receiving the response from Amazon FPS. For more information, see Working with Signatures. Type: String Size: 512 Bytes
`SignatureVersion`	A value that specifies the `Signature` format. Type: Integer Valid Values: 2
`SignatureMethod`	A value that specifies the signing method. Type: String Valid Values: HmacSHA256 (preferred) and HmacSHA1.

Document Conventions	« Previous Next »
Terms of Use	Did this page help you? Yes \| No \| Tell us about it...