Create a Checkout Link
Create and share your first checkout link via the API
Checkout Experience
What your customers see when they open a payment link
After Payment
Track status, handle webhooks, and manage links
API Reference
Full endpoint documentation with interactive playground
When to Use Hosted Checkout
Hosted Checkout and the Embedded Flow serve different integration needs:| Hosted Checkout | Embedded Flow | |
|---|---|---|
| Best for | Invoicing, ad-hoc payments, no-code scenarios | E-commerce checkouts, in-app payments |
| Integration effort | API call to create link, then share the URL | Embed iframe, handle postMessage events |
| Customer experience | Quidkey-hosted checkout page | Inline checkout on your site |
| Frontend code | None | HTML/JavaScript for iframe |
| Use case | B2B invoices, service payments, cross-border pay-ins | Online stores, subscription platforms |
How It Works
Link Lifecycle
Every payment link has a status that tracks its progress:| Status | Meaning |
|---|---|
| ACTIVE | Ready for use. Customers can open the link and complete payment. |
| USED | Payment completed (single-use links only). The link can no longer accept payments. |
| EXPIRED | Past its expiry time. Default expiry is 7 days, configurable at creation. |
| CANCELLED | Manually cancelled via API. |
Single-use vs Reusable: By default, links are single-use: they transition to USED when a customer completes payment. Set
link_type: "reusable" to create links that stay ACTIVE for repeated payments (useful for donation pages or recurring invoices).Key Features
- Shareable URLs: send via any channel: email, SMS, WhatsApp, messaging apps
- Hosted checkout page: Quidkey-branded checkout page, no frontend code needed. By default, customers see a Quidkey thank you or failure page after payment. Optionally redirect them back to your own site with custom
redirect_urls. - Configurable expiry: default 7 days, or set a custom duration
- Single-use and reusable: one-time payment links or persistent links for repeated use
- View tracking: see how many times a link has been opened
- Recoverable URLs: copy the link URL at any time from the Console or API (encrypted token storage)
- Link-to-transaction: when a link is used, navigate directly to the resulting transaction
Next Steps
Create your first payment link
Follow the Create a Checkout Link guide to generate and share your first link.
Understand the checkout experience
See what your customers see when they open a payment link.
Track and manage links
Learn how to monitor payment status, handle webhooks, and list your links.