Convenient Checkout API
The Convenient Checkout API (CCG API) is a RESTful service for executing payment and wallet operations server-to-server, without the Convenient Checkout UI. All payment operations require a PaymentMethodId instead of a raw card number to satisfy PCI compliance requirements.
Overview
Use the CCG API when you need programmatic, backend control over payment flows. Common scenarios include:
Recurring Payments
Charge a saved payment method on a schedule without customer interaction.
Wallet Management
Add, update, or remove payment methods on behalf of a customer.
PCI Payments
Process payments using a stored PaymentMethodId — no raw card data in transit.
Capture Authorized Payments
Complete a previously authorized transaction when goods or services are fulfilled.
API Scopes
Every request must include an OAuth Bearer token scoped to the operation. Use the table below to determine which scope to request:
| Scope | Used For |
|---|---|
merchant | Standard payment and session operations |
merchant-wallet-management | Managing customer wallets and payment methods |
pci | PCI-scoped payment operations |
See Authentication for how to obtain and attach access tokens to requests.
API Architecture
🔒 InternalInternal information — not visible in the public (merchant) site.
The CCG API runs on Azure Cloud with a multi-region, Kubernetes-native architecture:
| Component | Technology |
|---|---|
| Cloud | Azure, multi-region |
| Container orchestration | AKS (Azure Kubernetes Service) |
| API Gateway | Multi-cloud API Gateway |
| Ingress controller | ISTIO |
| Observability | Splunk |
| Database | Azure PostgreSQL |
Available APIs
In addition to the HCP API Catalog (Financial Package → Commerce subpackage), the following API groups are available:
Sessions
Create and manage checkout sessions that drive the payment lifecycle.
💳Payments
Single payments, split-tender, refunds, captures, and disputes.
🔔Webhooks
Event notifications for payment lifecycle changes and status updates.
🔑Authentication
OAuth token acquisition, scopes, and request header requirements.
⚠️Error Handling
Full reference of API error codes, meanings, and recommended resolutions.