Integration Guide

Learn how to connect your website or application to the CardPlusPay API to sell or fulfill gift cards.

Overview

This guide will walk you through authentication, core concepts, and step-by-step how-tos for displaying products, checking availability, creating orders, and managing order status.

Getting started

• Quick start — Prerequisites, API key, and your first API call.
• Concepts — Base URL, item codes, response envelope, stock check vs order status.
• Authentication — X-API-Key header, obtaining and securing your key.

How-to guides

Step-by-step guides for common tasks:

• How to display products from the catalog
• How to check product availability before purchase
• How to create an order (purchase a gift card)
• How to check order status and retrieve codes
• How to list orders and check balance

More

• API reference summary — Endpoint table and link to full reference
• SDK & code — PHP SDK usage and direct HTTP
• Security & best practices — API key, HTTPS, rate limits
• Errors & troubleshooting — Common errors and solutions
• Appendix — Glossary, resources, versioning

Full API specification: API Reference (OpenAPI/Redoc).