Skip to content

Express Docs v0.1.0


Express Docs / PayPalPayLaterOptions

Interface: PayPalPayLaterOptions

Defined in: src/types.ts:463

SDK-level options for the PayPal Pay Later provider (PayPal:PayLater).

Remarks

Identical to PayPalOptions except the funding source is always paylater and is not configurable. The SDK automatically adds enable-funding=paylater to the PayPal script URL.

Example

ts
const payLaterButton: ProviderButtonConfig<'PayPal:PayLater'> = {
  providerProtocolType: 'PayPal',
  paymentMethodType: 'PayLater',
  container: '#paylater-container',
  style: { color: 'gold', shape: 'rect' },
  options: {
    pspAutoCaptureEnabled: true,
    currencyCode: 'EUR',
  },
};

Extends

  • CheckoutFlowFlags

Properties

clientId?

optional clientId?: string

Defined in: src/types.ts:472

Your own PayPal client ID for direct authentication.

Remarks

Set this when you authenticate directly with your own PayPal developer app. When omitted the SDK falls back to partner mode. Must match the value used for PayPal:PayPalExpress if both are configured together.


currencyCode

currencyCode: string

Defined in: src/types.ts:482

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


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

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

Inherited from

CheckoutFlowFlags.isShippingCustomerDataRequired


merchantId?

optional merchantId?: string

Defined in: src/types.ts:480

PayPal merchant account ID.

Remarks

Required in partner mode (when clientId is omitted). Must match the value used for PayPal:PayPalExpress if both are configured together.


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 PayPalintent: 'capture' (true) / 'authorize' (false)
  • StripecaptureMethod: 'automatic' (true) / 'manual' (false)

Inherited from

CheckoutFlowFlags.pspAutoCaptureEnabled


userAction?

optional userAction?: PayPalUserAction

Defined in: src/types.ts:493

User action for the PayPal review page — see PayPalUserAction.

Remarks

Must match the "UserAction" setting of the CollanaPay ProviderAccount. Must match the value used for PayPal:PayPalExpress if both are configured together.

Default Value

'PAY_NOW' — when omitted the SDK explicitly sets commit=true (the PayPal JS SDK default).

CollanaPay SDK Documentation