Get started

Core concepts

Accept payments

Webhooks

API

API Reference Confirm a checkout session (public) POST Start a merchant application (public) POST Create a checkout session POST Create an API key POST Register a webhook endpoint POST Refund a payment POST Get the authenticated merchant GET Get checkout branding GET Retrieve a payment GET List subscribable event types GET List connectors GET List API keys GET List delivery attempts GET List webhook endpoints GET List payments GET Resolve a checkout session (public) GET Retry a failed delivery POST Enable or disable a webhook endpoint PATCH Submit a draft application (public) POST Send a test event POST Update checkout branding PATCH Update a connector PATCH Update merchant profile PATCH

Resources

API Reference

Every ShiftxPay endpoint, with an interactive playground.

The reference below is generated from the OpenAPI spec (openapi/shiftxpay-lite.yaml). Each operation page includes request and response schemas and a "Try it" playground that calls through the same-origin proxy.

Use the sidebar to browse endpoints by operation.

Delivery & idempotency

At-least-once delivery and how to dedupe.

Confirm a checkout session (public) POST