A modern TypeScript library for embedding Dodo Payments overlay checkout and listening to checkout events in real-time.
Option | Type | Required | Description |
---|---|---|---|
mode | string | Yes | Environment mode: ‘test’ or ‘live’ |
onEvent | function | Yes | Callback function for handling checkout events |
theme | string | No | UI theme: ‘light’ or ‘dark’ |
linkType | string | No | Payment link type: ‘static’ or ‘dynamic’ |
displayType | string | Yes | Display type, must be ‘overlay’ |
Option | Type | Required | Description |
---|---|---|---|
products | array | Yes* | Array of products to purchase |
paymentLink | string | Yes* | payment link for dynamic payment link |
redirectUrl | string | No | URL to redirect after payment |
queryParams | object | No | Additional query parameters |
products
or paymentLink
must be provided
Note: Apple Pay is not currently supported in the overlay checkout experience. We plan to add support for Apple Pay in a future release.
onEvent
callback: