Integration guide
Integration scoping for payments, widgets, and partner flows.
Use this page to plan hosted checkout, widget embeds, webhook reconciliation, and platform work before production credentials are issued.
Integration
A cleaner path to launch.
Hosted flows, widgets, webhooks, and reconciliation.
Quickstart
Plan the integration first, then ship with the correct rail.
OmniPay scopes the payment rail, hosted or embedded user experience, webhook events, and operational handoff before production credentials are issued.
- Hosted checkout keeps card data out of your app.
- Server-side proxy routes keep provider credentials out of the browser.
- Webhook and reconciliation plans are confirmed before launch.
- Platform plugins or custom service routes are scoped by project need.
// Scoping payload
{
"rail": "hosted-checkout | provider-widget | platform-plugin",
"currency": "CAD",
"experience": "redirect | embedded",
"webhooks": ["payment.completed", "payment.failed"],
"launchMode": "sandbox-first"
}Integration options
Use the path that matches your stack.
Hosted checkout, embedded widgets, server-side proxy routes, webhooks, and platform plugins are separated so teams can start small and add complexity only when needed.
Hosted
Hosted Checkout
Project-scoped hosted payment flows for merchants that should avoid handling card data directly.
- UX scope
- Brand settings
- Security boundary
Secure route
Service routes
Server-side route patterns, provider credential boundaries, and implementation handoff.
- Route plan
- Credential boundary
- Request shape
Events
Signed Webhooks
Payment lifecycle events with payload structure, retry logic, reconciliation, and replay expectations.
- Event map
- Retry plan
- Fulfillment guard
Platform
Commerce Plugins
Project-specific commerce platform work when an off-the-shelf plugin is not the right fit.
- Storefront fit
- Credential setup
- Order status sync