Skip to main content

​
List businesses

GET /api/businesses Returns all businesses associated with your account. 
curl --request GET \
  --url https://api.cleo-pay.com/api/businesses \
  --header "Authorization: Bearer <token>"

​
Get business details

GET /api/businesses/{businessId} Returns full details for a single business.

​
Path parameters

​
businessId
string
required
The unique ID of the business.
curl --request GET \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123 \
  --header "Authorization: Bearer <token>"

​
Update business alias

PATCH /api/businesses/{businessId}/alias Sets a display alias for the business. The alias appears in the Cleo Pay UI and in communications with connected businesses.

​
Path parameters

​
businessId
string
required
The unique ID of the business.

​
Request body

​
alias
string
required
The new alias for the business.
curl --request PATCH \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/alias \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{ "alias": "Acme Payments" }'
POST /api/businesses/{businessId}/logo Uploads a logo image for the business. Send the image as multipart/form-data.

​
Path parameters

​
businessId
string
required
The unique ID of the business.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/logo \
  --header "Authorization: Bearer <token>" \
  --form "file=@/path/to/logo.png"
DELETE /api/businesses/{businessId}/logo Removes the current logo from the business profile.

​
Path parameters

​
businessId
string
required
The unique ID of the business.
curl --request DELETE \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/logo \
  --header "Authorization: Bearer <token>"

​
Get balance

GET /api/businesses/{businessId}/balance Returns the current Cleo Pay balance for the business. Balances accumulate when payments are received and can be withdrawn to a linked bank account.

​
Path parameters

​
businessId
string
required
The unique ID of the business.
curl --request GET \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/balance \
  --header "Authorization: Bearer <token>"

​
Withdraw balance

POST /api/businesses/{businessId}/withdraw-balance Initiates a withdrawal of the available balance to the business’s default bank account.

​
Path parameters

​
businessId
string
required
The unique ID of the business.

​
Request body

​
amount
number
required
Amount to withdraw in dollars. Must not exceed the available balance.
​
fundingSourceId
string
required
The bank account to receive the withdrawn funds.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/withdraw-balance \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "amount": 500.00,
    "fundingSourceId": "fs_xyz789"
  }'