Skip to content

collana pay JS Docs v0.1.0


collana pay JS Docs / AmazonPayOptions

Interface: AmazonPayOptions

Defined in: types.ts:179

SDK-level options for the Amazon Pay provider (Amazon:AmazonPay).

Remarks

These values are forwarded to the Amazon Pay renderButton and initCheckout calls. See Amazon Pay docs.

Example

ts
const amazonButton: ProviderButtonConfig<'Amazon:AmazonPay'> = {
  providerProtocolType: 'Amazon',
  paymentMethodType: 'AmazonPay',
  container: '#amazon-container',
  style: { color: 'Gold' },
  options: {
    publicKeyId: 'SANDBOX-AGUS2ZW5JXOAIYKS3WJQLLSD',
    currencyCode: 'EUR',
    checkoutLanguage: 'de_DE',
    productType: 'PayAndShip',
    placement: 'Cart',
  },
};

Properties

checkoutLanguage?

optional checkoutLanguage?: string

Defined in: types.ts:195

Checkout UI language.

Example

ts
`'de_DE'`, `'en_US'`, `'en_GB'`

currencyCode

currencyCode: string

Defined in: types.ts:190

ISO 4217 currency code (e.g. 'EUR', 'USD', 'GBP').


estimatedOrderAmount?

optional estimatedOrderAmount?: number

Defined in: types.ts:207

Estimated order amount in minor units (e.g. 19300 = €193.00).

Remarks

Optional but recommended — gives the buyer a price preview. Uses the currency specified by currencyCode.


merchantId

merchantId: string

Defined in: types.ts:181

Amazon Pay merchant ID.


placement?

optional placement?: "Home" | "Product" | "Cart" | "Checkout" | "Other"

Defined in: types.ts:199

Where the button is placed in the checkout flow.


productType?

optional productType?: "PayAndShip" | "PayOnly"

Defined in: types.ts:197

Determines the buyer experience — whether shipping is required.


publicKeyId

publicKeyId: string

Defined in: types.ts:188

Amazon Pay public key ID for signature verification.

Remarks

Use a SANDBOX- prefixed key in sandbox mode and the live key in production.


region?

optional region?: "EU" | "NA" | "FE"

Defined in: types.ts:212

Amazon Pay SDK region. Determines which checkout.js endpoint is loaded.

Default Value

'EU'

CollanaPay SDK Documentation