Express Docs v0.1.0

---

Express Docs / RevolutPayOptions

Interface: RevolutPayOptions

Defined in: src/types.ts:1030

SDK-level options for the Revolut Pay provider (Revolut:RevolutPay).

Remarks

These values are forwarded to the Revolut Checkout Payments SDK when initializing and mounting the RevolutPay widget.

Checkout flow flags (isShippingCustomerDataRequired):

• false (default) — Revolut Pay collects the shipping address from the shopper (express checkout flow). Maps to requestShipping: true in the SDK.
• true — the integrator's backend already supplies the shipping address; Revolut Pay skips address collection. Maps to requestShipping: false in the SDK.

Example

const revolutPayButton: ProviderButtonConfig<'Revolut:RevolutPay'> = {
  providerProtocolType: 'Revolut',
  paymentMethodType: 'RevolutPay',
  container: '#revolut-pay-container',
  style: { variant: 'dark', radius: 'small' },
  options: {
    publicToken: 'pk_live_abc123',
    currency: 'EUR',
    totalAmount: 19300,
  },
};

Extends

• CheckoutFlowFlags

Properties

currency

currency: string

Defined in: src/types.ts:1039

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

---

isBillingCustomerDataRequired?

optional isBillingCustomerDataRequired?: boolean

Defined in: src/types.ts:252

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

Inherited from

CheckoutFlowFlags.isBillingCustomerDataRequired

---

isShippingCustomerDataRequired?

optional isShippingCustomerDataRequired?: boolean

Defined in: src/types.ts:1055

When true, the integrator's backend already supplies the customer's shipping address and Revolut Pay should not request it from the shopper. When false or unset (default), Revolut Pay collects the shipping address (express checkout flow).

Maps (inverted) to the Revolut SDK requestShipping mount option: requestShipping = !isShippingCustomerDataRequired.

Default Value

false — Revolut Pay collects shipping address

Overrides

CheckoutFlowFlags.isShippingCustomerDataRequired

---

locale?

optional locale?: string

Defined in: src/types.ts:1063

Locale for the Revolut Pay checkout UI.

Remarks

Accepts any common format (de-DE, de_DE, or de). The SDK normalizes to the short code expected by Revolut (e.g. de).

---

pspAutoCaptureEnabled

pspAutoCaptureEnabled: boolean

Defined in: src/types.ts:262

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

---

publicToken

publicToken: string

Defined in: src/types.ts:1037

Revolut public API key for authentication.

Remarks

Use a sandbox key in sandbox mode and the live key in production.

---

totalAmount

totalAmount: number

Defined in: src/types.ts:1043

Total payment amount in minor units (e.g. 19300 = €193.00).