Checkout SDK

@lynqpay/checkout-sdk embeds Lynq’s hosted payment form in a browser page.

npm install @lynqpay/checkout-sdk

For a no-build integration, use the version-pinned browser bundle:

<script src="https://unpkg.com/@lynqpay/checkout-sdk@1.0.0/dist/lynq.js"></script>

The classic script exposes window.Lynq.

const checkout = new Checkout({
  publicKey: "pk_test_...",
  clientSecret: paymentIntent.clientSecret,
  locale: "en",
  labelStyle: "floating",
});

Option	Required	Default
`publicKey`	Yes	—
`clientSecret`	Yes	—
`environment`	No	`production`
`locale`	No	`en`
`debug`	No	`false`
`labelStyle`	No	`floating`

mount() begins asynchronous initialization. unmount() removes the iframe and lets the instance be mounted again. destroy() permanently removes it and all listeners.

Server-rendered applications

The SDK is browser-only. In SSR applications, construct and mount Checkout in client-side code after hydration. Constructing it on the server throws ConfigError.

Last modified on August 7, 2026

Start here

Payment methods

Build your integration

Test and go live

Reference

Resources

Checkout SDK

Checkout SDK

Server-rendered applications

​Checkout SDK

​Server-rendered applications

Checkout SDK

Server-rendered applications