Interface CheckoutOpenOptions

interface CheckoutOpenOptions {
    mode?: CheckoutMode;
    onSuccess?: (data: CheckoutSuccessData) => void;
    onCancel?: () => void;
    returnUrl?: string;
}

Index

Properties

mode? onSuccess? onCancel? returnUrl?

Properties

`Optional`mode

mode?: CheckoutMode

How to open the checkout:

redirect — navigate the current tab (default)
popup — open in a new browser window

Do not use an iframe/modal — ClickPay blocks framed payment pages.

`Optional`onSuccess

onSuccess?: (data: CheckoutSuccessData) => void

Called after the contribution session is successfully created.

`Optional`onCancel

onCancel?: () => void

Called if the user closes or cancels the checkout.

`Optional`returnUrl

returnUrl?: string

URL to navigate to after a successful redirect-mode checkout. Appended as ?returnUrl=… to the hosted checkout URL.