API Reference

Complete reference for the Circular Pay REST API. Base URL: api.circularpay.io/v1

Base URL: https://api.circularpay.io/v1

Auth: Bearer sk_live_...

Content-Type: application/json

POST/v1/charges

Charges

Create, capture, and refund charges. Supports one-time payments, authorization holds, and partial captures.

View endpoints
POST/v1/customers

Customers

Create and manage customer profiles. Store payment methods on file for future transactions.

View endpoints
POST/v1/invoices

Invoices

Generate and send invoices. Track payment status, send reminders, and accept partial payments.

View endpoints
POST/v1/subscriptions

Subscriptions

Create recurring billing plans. Manage trials, upgrades, downgrades, and cancellations.

View endpoints
POST/v1/refunds

Refunds

Issue full or partial refunds on completed charges. Track refund status and settlement timing.

View endpoints
POST/v1/webhooks

Webhooks

Register webhook endpoints to receive real-time event notifications. Manage subscriptions and view delivery logs.

View endpoints

Start integrating today

Get API KeysRead the Docs