Express Docs v0.1.0

---

Express Docs / ProviderButtonConfig

Interface: ProviderButtonConfig<K>

Defined in: src/types.ts:1284

Configuration for a single payment button.

Remarks

The generic parameter K narrows style and options to the correct provider-specific types based on the providerProtocolType and paymentMethodType combination.

Type Parameters

K

K extends ProviderKey = ProviderKey

A ProviderKey literal that determines the allowed style and options shapes.

Properties

container

container: string

Defined in: src/types.ts:1290

CSS selector for the DOM element where the button will be rendered.

---

id?

optional id?: string

Defined in: src/types.ts:1296

Optional integrator-defined identifier for this button configuration. Passed through to ProviderIdentity in callbacks so integrators can correlate a callback to the specific button that triggered it.

---

options?

optional options?: ProviderOptionsMap[K]

Defined in: src/types.ts:1300

Provider-specific SDK and behaviour options.

---

paymentMethodType

paymentMethodType: ExtractMethod<K>

Defined in: src/types.ts:1288

The payment method this button represents.

---

providerProtocolType

providerProtocolType: ExtractProtocol<K>

Defined in: src/types.ts:1286

The payment processor / gateway for this button.

---

style?

optional style?: ProviderStyleMap[ExtractMethod<K>]

Defined in: src/types.ts:1298

Provider-specific visual style options.