APICenter
DocsBuildLearn

APICenter REST API

This reference describes payment operations declared in the public OpenAPI contract. Shared services have separate integration guides; their endpoints are not included in this contract.

API basics

All endpoints live under https://api.apicenter.itsandbox.site and follow REST conventions with JSON request/response bodies over HTTPS.

Authentication

Use your consumer payment API key in the Authorization header. See the authentication guide for credential ownership and shared-service tokens.

Authorization: Bearer <PAYMENT_API_KEY>

Idempotency & Retries

Payment mutations require an Idempotency-Key. Completed responses replay for seven days; for an uncertain provider outcome, keep the same key and reconcile before starting a new payment.

Idempotency-Key: <UUID>

Rate limits

Quotas depend on the configured consumer policy. See the rate-limit guidefor handling throttling; this contract does not declare fixed per-minute quotas.

Endpoints

All endpoints grouped by domain. Click to view full documentation with code examples.

Checkouts

POST/api/v1/payments/checkoutsCreate a CheckoutGET/api/v1/payments/checkouts/{checkoutId}Get a CheckoutGET/api/v1/payments/checkouts/by-reference/{referenceId}Get Checkout by ReferencePOST/api/v1/payments/checkouts/{checkoutId}/cancelCancel Checkout

Payment Intents

POST/api/v1/payments/intentsCreate a Payment IntentGET/api/v1/payments/intents/{paymentIntentId}Get a Payment IntentPOST/api/v1/payments/intents/{paymentIntentId}/confirmConfirm a Payment IntentPOST/api/v1/payments/intents/{paymentIntentId}/cancelCancel a Payment IntentPOST/api/v1/payments/intents/qrphCreate Qr Ph Payment Intent

Customers

POST/api/v1/payments/customersCreate a CustomerGET/api/v1/payments/customers/{customerId}Get a Customer

Refunds

POST/api/v1/payments/refundsCreate a RefundGET/api/v1/payments/refunds/{refundId}Get a Refund

Subscriptions & Billing

POST/api/v1/payments/subscriptionsCreate a SubscriptionGET/api/v1/payments/subscriptions/{subscriptionId}Get a SubscriptionPOST/api/v1/payments/subscriptions/{subscriptionId}/cancelCancel a SubscriptionGET/api/v1/payments/subscriptions/{subscriptionId}/invoicesList Subscription InvoicesGET/api/v1/payments/invoices/{invoiceId}Get an Invoice

General

GET/api/v1/payments/recordsList Payment RecordsGET/api/v1/payments/payment-linksList Payment LinksPOST/api/v1/payments/payment-linksCreate Payment LinkGET/api/v1/payments/payment-links/{paymentLinkId}Get Payment LinkPATCH/api/v1/payments/payment-links/{paymentLinkId}Set Payment Link ArchivedGET/api/v1/payments/plansList PlansPOST/api/v1/payments/plansCreate PlanGET/api/v1/payments/plans/{planId}Get Plan

Capabilities & System

GET/api/v1/payments/capabilitiesGet Payment Capabilities

On this page

API basicsAuthenticationIdempotencyRate limitsEndpoints