There Are 2 Ways to Integrate
Hosted Page (Redirect)
Your server creates a session. Customer is sent to our checkout page to pay, then redirected back. Simplest integration — start here.
Embedded (Popup / Iframe)
Same flow, but the checkout opens as a popup or embeds directly in your page. Customer never leaves your site.
How It Works
What You’ll Need
Before you start, gather these credentials:| Credential | Where to Find | What It’s For |
|---|---|---|
| Vault API Key | Provided at signup | Put in X-API-KEY header (authenticates with secure card storage) |
| Merchant API Key | Dashboard → Settings → API Keys | Put in X-OZURA-API-KEY header (identifies your account) |
| Merchant ID | Dashboard → Settings → Account | Put in request body as merchantId |
Don’t have your Vault API Key? This was provided when you first signed up. If you didn’t save it, contact Ozura support. Don’t have an Ozura account? Contact the Ozura sales team to get started.
Coming from OzElements? If you’ve been using OzElements to tokenize cards directly and are wondering what to do with your Vault Pub Key (
X-Pub-Key) — you don’t need to worry about it here. Checkout handles tokenization and pub key authentication internally. You only need the three credentials listed above.Capabilities
| Feature | Description |
|---|---|
| Simple Payments | Charge a flat amount (e.g., $25.00) |
| Itemized Cart | Show product images, quantities, and discounts |
| Donation Mode | Preset amount buttons with optional custom input |
| Payment Links | Shareable URLs for email, social media, or invoices |
| Display Modes | Redirect, popup, iframe, or new tab |
| Custom Branding | Match checkout to your brand colors and logo |
| Multi-Currency | Accept payments in USD, EUR, GBP, CAD, and more |
I Want To…
| Question | Answer |
|---|---|
| Accept my first payment quickly | Quickstart |
| Understand all session creation options | Create a Session |
| Choose redirect, popup, iframe, or new tab | Integration Modes |
| Handle success, errors, and cancellations | Handle the Result |
| Create shareable payment URLs | Payment Links |
| Accept donations | Donation Mode |
| Match checkout to my brand | Customize Appearance |
| See supported currencies | Currencies |
| Test before going live | Testing Guide |
| Keep my integration secure | Security Best Practices |
| See the full endpoint reference | API Reference |
| Fix an error | Troubleshooting |
| Understand error codes and retry logic | Error Handling |