Express Docs v0.1.0

---

Express Docs / AmazonPayOptions

Interface: AmazonPayOptions

Defined in: src/types.ts:296

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

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

Extends

• CheckoutFlowFlags

Properties

currencyCode

currencyCode: string

Defined in: src/types.ts:307

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

---

estimatedOrderAmount?

optional estimatedOrderAmount?: number

Defined in: src/types.ts:329

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.

---

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

---

locale?

optional locale?: string

Defined in: src/types.ts:317

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

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

---

merchantId

merchantId: string

Defined in: src/types.ts:298

Amazon Pay merchant ID.

---

placement?

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

Defined in: src/types.ts:321

Where the button is placed in the checkout flow.

---

productType?

optional productType?: "PayAndShip" | "PayOnly"

Defined in: src/types.ts:319

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:305

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:334

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

Default Value

'EU'