Express Docs v0.1.0

---

Express Docs / BraintreePayPalExpressOptions

Interface: BraintreePayPalExpressOptions

Defined in: src/types.ts:1162

SDK-level options for the Braintree PayPal Express provider (Braintree:PayPalExpress).

Remarks

Uses the Braintree JS v3 SDK (client + paypal-checkout modules) with the modern PayPal Buttons API. The tokenizationKey field is a static credential from the Braintree Control Panel — no server request is needed before rendering the button.

Per-order payment details (amount, currency, line items, etc.) are provided dynamically through the onClick callback return value in checkoutData.paymentOptions. These are forwarded to paypalCheckoutInstance.createPayment().

Example

const braintreePayPal: ProviderButtonConfig<'Braintree:PayPalExpress'> = {
  providerProtocolType: 'Braintree',
  paymentMethodType: 'PayPalExpress',
  container: '#braintree-paypal-container',
  style: { color: 'gold', shape: 'rect' },
  options: {
    tokenizationKey: 'sandbox_g42y39zp_348jhnfdew59qi3c',
    intent: 'authorize',
    currencyCode: 'EUR',
    locale: 'de_DE',
  },
};

Extends

• CheckoutFlowFlags

Properties

currencyCode

currencyCode: string

Defined in: src/types.ts:1172

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

---

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

BCP 47 locale for the PayPal button (e.g. 'de_DE', 'en_US').

---

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

---

tokenizationKey

tokenizationKey: string

Defined in: src/types.ts:1170

Braintree tokenization key from the Braintree Control Panel.

Remarks

A static credential (e.g. sandbox_xxx_yyy) that requires no server-side request before rendering the button.