Skip to content

Express Docs v0.1.0


Express Docs / AmazonPayOptions

Interface: AmazonPayOptions ​

Defined in: src/types.ts:302

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.

Supported CheckoutFlowFlags combinations:

  • isShippingCustomerDataRequired: false, isBillingCustomerDataRequired: false — Express flow; Amazon Pay collects all customer data (default).
  • isShippingCustomerDataRequired: true, isBillingCustomerDataRequired: true — Both shipping and billing data are required from the integrator's backend; Amazon Pay skips its native address collection. Mixed combinations (true/false or false/true) are not supported for this provider.

Example ​

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

Currencies: the button is rendered with the ledger currency of the Amazon Pay account. The currency the buyer pays in (presentment currency) and the estimated order amount come from the collana pay transaction via checkoutData, so a transaction in e.g. CHF works with an EUR ledger without further configuration.

Extends ​

  • CheckoutFlowFlags

Properties ​

isBillingCustomerDataRequired? ​

optional isBillingCustomerDataRequired?: boolean

Defined in: src/types.ts:253

When true, billing address data is required from the customer.

Inherited from ​

CheckoutFlowFlags.isBillingCustomerDataRequired


isShippingCustomerDataRequired? ​

optional isShippingCustomerDataRequired?: boolean

Defined in: src/types.ts:251

When true, shipping address data is required from the customer.

Inherited from ​

CheckoutFlowFlags.isShippingCustomerDataRequired


ledgerCurrency ​

ledgerCurrency: "EUR" | "GBP" | "USD" | "JPY"

Defined in: src/types.ts:322

Ledger currency of the Amazon Pay merchant account, as set during registration.

Remarks ​

This is not the transaction currency: it must match the ledger currency configured for the Amazon Pay provider account in collana pay (EU merchants 'EUR', UK 'GBP', US 'USD', JP 'JPY'). The transaction currency is taken from the transaction.

Replaces the former currencyCode option; passing currencyCode is rejected.


locale? ​

optional locale?: string

Defined in: src/types.ts:332

Locale for the Amazon Pay checkout UI.

Remarks ​

Accepts any common format (de-DE, de_DE, or de). The SDK normalizes to the underscore format expected by Amazon Pay (e.g. de_DE).

Example ​

ts
`'de_DE'`, `'en_US'`, `'en-GB'`, `'de'`

merchantId ​

merchantId: string

Defined in: src/types.ts:304

Amazon Pay merchant ID.


placement? ​

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

Defined in: src/types.ts:336

Where the button is placed in the checkout flow.


productType? ​

optional productType?: "PayAndShip" | "PayOnly"

Defined in: src/types.ts:334

Determines the buyer experience — whether shipping is required.


pspAutoCaptureEnabled ​

pspAutoCaptureEnabled: boolean

Defined in: src/types.ts:263

When true (default), the payment is captured immediately after authorization. When false, the payment is authorized only and must be captured separately.

Remarks ​

This flag is mapped to the provider-native concept:

  • PayPal / Braintree / Adyen PayPal → intent: 'capture' (true) / 'authorize' (false)
  • Stripe → captureMethod: 'automatic' (true) / 'manual' (false)

Inherited from ​

CheckoutFlowFlags.pspAutoCaptureEnabled


publicKeyId ​

publicKeyId: string

Defined in: src/types.ts:311

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: src/types.ts:341

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

Default Value ​

'EU'

collana pay SDK Documentation