Skip to main content
Before you can create payables or send payments, both businesses must be connected on Cleo Pay. You can invite another business to connect in two ways:
  1. Email invitation — send a direct invitation to a specific email address
  2. Public shareable link — generate a link anyone can use to connect with your business (no email required)

​
Send an invitation

POST /api/businesses/{businessId}/invitations Sends a connection invitation to a business by email address.

​
Path parameters

​
businessId
string
required
The ID of your business sending the invitation.

​
Request body

​
email
string
required
Email address to send the invitation to.
​
aliasName
string
An optional display name you want to use for this connection after it is accepted.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/invitations \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "email": "vendor@example.com",
    "aliasName": "Example Vendor"
  }'

​
List sent invitations

GET /api/businesses/{businessId}/invitations Returns all outgoing invitations sent by the business, including their current status.

​
Path parameters

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

​
Cancel an invitation

POST /api/businesses/{businessId}/invitations/{invitationId}/cancel Cancels a pending invitation. The recipient can no longer use the invitation link after it is cancelled.

​
Path parameters

​
businessId
string
required
The ID of your business.
​
invitationId
string
required
The ID of the invitation to cancel.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/invitations/inv_pqr678/cancel \
  --header "Authorization: Bearer <token>"

​
Resend an invitation

POST /api/businesses/{businessId}/invitations/{invitationId}/resend Resends an existing invitation email to the original recipient.

​
Path parameters

​
businessId
string
required
The ID of your business.
​
invitationId
string
required
The ID of the invitation to resend.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/invitations/inv_pqr678/resend \
  --header "Authorization: Bearer <token>"

​
Accept an invitation

POST /api/businesses/{businessId}/invitations/accept Accepts a received connection invitation and establishes the connection between the two businesses.

​
Path parameters

​
businessId
string
required
The ID of the business accepting the invitation.

​
Request body

​
token
string
required
The invitation token from the invitation email or link.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_xyz999/invitations/accept \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{ "token": "invite-token-abc" }'

​
Reject an invitation

POST /api/businesses/{businessId}/invitations/{invitationId}/reject Rejects a received connection invitation.

​
Path parameters

​
businessId
string
required
The ID of the business rejecting the invitation.
​
invitationId
string
required
The ID of the invitation to reject.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_xyz999/invitations/inv_pqr678/reject \
  --header "Authorization: Bearer <token>"

​
Public invite settings

PATCH /api/businesses/{businessId}/public-invite-settings Configures your business’s public shareable invite link. You can enable or disable the link, and set whether it requires approval before establishing a connection.

​
Path parameters

​
businessId
string
required
The ID of your business.

​
Request body

​
enabled
boolean
required
Set to true to enable the public invite link, false to disable it.
​
requireApproval
boolean
If true, incoming connections via the public link require manual approval before becoming active.
curl --request PATCH \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/public-invite-settings \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "enabled": true,
    "requireApproval": false
  }'
After enabling the public invite link, retrieve your business profile to get the shareable URL. Share it with vendors or customers so they can connect with your business without a direct email invitation.