Documentation Index
Fetch the complete documentation index at: https://docs.cleo-pay.com/llms.txt
Use this file to discover all available pages before exploring further.
Cleo Pay lets you receive ACH payments from other businesses — whether they’re existing Cleo Pay users or external payers using a payment link. This guide covers how to configure your business to accept payments and monitor incoming funds.
Choose your business type
Full business
Basic (receive-only)
A full business can both send and receive payments. Register with POST /api/businesses and complete KYB verification.Full business registration is required if you plan to send payments in addition to receiving them. See Business Setup for complete onboarding steps. A basic business is a lighter-weight option for businesses that only need to receive payments. It requires minimal information and skips the full KYB process.curl -X POST https://api.cleo-pay.com/api/businesses/basic \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Corp",
"ein": "12-3456789",
"address": {
"street1": "123 Main St",
"city": "Austin",
"state": "TX",
"postalCode": "78701",
"country": "US"
}
}'
Basic businesses cannot initiate outbound payments. Upgrade to a full business at any time by completing the full registration and KYB flow.
Set up your Pay-Me Link
Your Pay-Me Link is a unique URL that lets anyone — including payers who aren’t on Cleo Pay — send you an ACH payment directly. Configure it after your business is registered:
Get your Pay-Me Link settings
Retrieve your current Pay-Me Link configuration and eligibility status:curl https://api.cleo-pay.com/api/businesses/biz_abc123/pay-me-link \
-H "Authorization: Bearer YOUR_TOKEN"
Enable and configure the link
Enable your Pay-Me Link and optionally set minimum and maximum payment amounts:curl -X POST https://api.cleo-pay.com/api/businesses/biz_abc123/pay-me-link/configure \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"enabled": true,
"minAmount": 1000,
"maxAmount": 10000000
}'
Amounts are in cents. 1000 = 10.00,‘10000000‘=100,000.00. Share your Pay-Me Link
Your Pay-Me Link is available at https://app.cleo-pay.com/pay-me/{token}. Include it in emails, invoices, and your website so payers can send funds to you directly.To generate a new token (for example, if you want to invalidate the old link):curl -X POST https://api.cleo-pay.com/api/businesses/biz_abc123/pay-me-link/regenerate-token \
-H "Authorization: Bearer YOUR_TOKEN"
Use payment links on invoices
For invoice-specific payments, enable a payment link on a specific payable. Your customer receives a unique URL to pay that exact invoice:
Enable a payment link for a payable
curl -X POST https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_xyz789/payment-link/enable \
-H "Authorization: Bearer YOUR_TOKEN"
Send the payment link to your customer
Send the payment link via email directly from Cleo Pay:curl -X POST https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_xyz789/payment-link/send \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"email": "accounts@customer.com",
"message": "Please pay invoice INV-2026-042 at your earliest convenience."
}'
Check payment link status
Verify whether the payment link is active and whether the invoice has been paid:curl https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_xyz789/payment-link \
-H "Authorization: Bearer YOUR_TOKEN"
Monitor incoming payments
Use GET /api/getting-paid-payables to see all payables where your business is the payee — including payments from Cleo Pay connections and external payers:
curl https://api.cleo-pay.com/api/getting-paid-payables \
-H "Authorization: Bearer YOUR_TOKEN"
Withdraw your balance
When payments are received, they settle into your Cleo Pay balance. Withdraw to your connected bank account at any time:
curl -X POST https://api.cleo-pay.com/api/businesses/biz_abc123/withdraw-balance \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"amount": 500000,
"fundingSourceId": "fs_abc123"
}'
curl https://api.cleo-pay.com/api/businesses/biz_abc123/balance \
-H "Authorization: Bearer YOUR_TOKEN"