Checkout Overview

Ozura Checkout is a hosted, PCI-compliant payment page. Your server creates a session, the customer pays on our secure page, and we redirect them back to your site. You never touch credit card data.

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	Developers → Vault Key	Put in `X-API-KEY` header (authenticates with secure card storage)
Merchant API Key	Developers → API Keys	Put in `X-OZURA-API-KEY` header (identifies your account)
Merchant ID	Developers → Identity	Put in request body as `merchantId`

Don’t have your Vault API Key? Find it under Developers → Vault Key. 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.

Checkout users never need a Vault Pub Key. Checkout handles pub key authentication server-side for both production and test vault keys. (Pub key requirements only matter when integrating Elements directly — see the Elements Installation guide.)

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
Recurring Mode	Subscriptions and memberships — customer pays once, billing continues automatically
Surcharge	Add a configurable credit card surcharge (up to 3%) displayed as a line item
Payment Links	Shareable URLs for email, social media, or invoices
Display Modes	Redirect, popup, iframe, or new tab
Custom Branding	Match the hosted page to your brand (colors, logo, typography); see Customize Appearance
Theme Preview	Embed a live checkout preview in your dashboard to test appearance changes without a real session
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
Set up subscriptions and recurring billing	Recurring Mode
Add a credit card surcharge	Recurring Mode → Surcharge Reference
Preview appearance without a real session	Theme Preview
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

Quick Reference

Quickstart

Accept your first payment in 5 minutes

Create a Session

Full guide to session creation and all options

API Reference

Complete endpoint reference

Testing Guide

Test your integration before going live

​There Are 2 Ways to Integrate

Hosted Page (Redirect)

Embedded (Popup / Iframe)

​How It Works

​What You’ll Need

​Capabilities

​I Want To…

​Quick Reference

Quickstart

Create a Session

API Reference

Testing Guide

There Are 2 Ways to Integrate

How It Works

What You’ll Need

Capabilities

I Want To…

Quick Reference