Quickstart
Pay your first bill in the sandbox.
Authentication
API keys, hosts and scopes.
API Reference
Every endpoint: business, bills, custom fields, payments, contacts, invoices, balance and webhooks.
Overview
The two payment rails, hosts and data conventions.
What you can build
Bills
Create a bill for a vendor and submit it into the business’s approval flow.
Payments
Pay a bill or a contact, then list, read, cancel and retry payments.
Funding sources
See what the business can pay from on each rail.
Invoices
Send invoices with a hosted pay link, void them, or mark them paid.
Balance
Read the Cleo Pay balance and withdraw to a verified bank.
Webhooks
Register endpoints and receive signed events.
Get started in 3 steps
1
Get a key
An admin creates an API key with the scopes you need in the Cleo web app. Sandbox keys start with
cleo_test_ and work only on https://api.stg.cleo-pay.com. See Authentication.2
Check the business
Call
GET /v1/business to see the setup stage and which rails can send money. Banks are linked in the Cleo web app, not through the API. See Bank accounts.3
Pay a bill
Create and submit a bill, pick a funding source, and pay it with an
Idempotency-Key. See Send a payment.