API reference

A REST API you can reason about

Predictable resource-oriented URLs, JSON everywhere, idempotent writes, and clear errors. Test in the sandbox before you ever touch production.

Core resources

The building blocks

Payments

Create, capture, refund, and retrieve payments across every method.

Payouts

Send funds to recipients and track each transfer to completion.

Customers

Store customers and their saved, tokenized payment methods.

Subscriptions

Plans, invoices, and recurring billing with smart retries.

Events

Every state change emitted as a signed, replayable webhook event.

Disputes

Respond to chargebacks and submit evidence programmatically.

Example

Retrieve a payment

Authenticate with a bearer token; every response is JSON.

# GET a payment curl https://api.clearflow.io/v1/payments/pay_8Hk2 \ -u "$CF_KEY:" # → 200 OK { "id": "pay_8Hk2", "status": "succeeded", "amount": 4200, "currency": "usd" }

Read the full reference

Create a sandbox key and explore every endpoint with live examples.