Skip to main content
Cleo Pay provides two types of shareable payment links:
  • Payment links — per-invoice links that let an external payer pay a specific invoice without a Cleo Pay account
  • Pay-me links — business-level links that let anyone pay your business an arbitrary amount (within configured limits)
Payment links are tied to a specific payable. Share the link with your customer to let them pay the invoice directly via ACH through Plaid, without needing a Cleo Pay account. GET /api/businesses/{businessId}/payables/{payableId}/payment-link Returns the current status of the payment link for a specific payable, including whether it is enabled and the shareable URL.

​
Path parameters

​
businessId
string
required
The ID of the business that owns the payable.
​
payableId
string
required
The ID of the payable.

​
Response fields

​
nanoId
string
The unique token that identifies the payment link. Used to construct the link URL.
​
status
string
Whether the payment link is enabled or disabled.
​
url
string
The full shareable URL for the payment link.
curl --request GET \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_ghi789/payment-link \
  --header "Authorization: Bearer <token>"
POST /api/businesses/{businessId}/payables/{payableId}/payment-link/enable Enables the payment link for a payable, making the link shareable.

​
Path parameters

​
businessId
string
required
The ID of the business.
​
payableId
string
required
The ID of the payable.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_ghi789/payment-link/enable \
  --header "Authorization: Bearer <token>"
POST /api/businesses/{businessId}/payables/{payableId}/payment-link/disable Disables an active payment link. The link URL becomes invalid and the payer can no longer use it to pay.

​
Path parameters

​
businessId
string
required
The ID of the business.
​
payableId
string
required
The ID of the payable.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_ghi789/payment-link/disable \
  --header "Authorization: Bearer <token>"
POST /api/businesses/{businessId}/payables/{payableId}/payment-link/send Sends the payment link to a contact via email. The payment link must be enabled before sending.

​
Path parameters

​
businessId
string
required
The ID of the business.
​
payableId
string
required
The ID of the payable.

​
Request body

​
email
string
required
The email address to send the payment link to.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/payables/pay_ghi789/payment-link/send \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{ "email": "customer@example.com" }'
A pay-me link is a business-level link you can share publicly or embed in your website. Anyone can use it to pay your business via ACH. You control whether it is active and set the minimum and maximum payment amounts. GET /api/businesses/{businessId}/pay-me-link Returns the current pay-me link configuration and eligibility status for the business.

​
Path parameters

​
businessId
string
required
The ID of the business.
curl --request GET \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/pay-me-link \
  --header "Authorization: Bearer <token>"
POST /api/businesses/{businessId}/pay-me-link/configure Enables or disables the pay-me link and sets the allowed payment amount range.

​
Path parameters

​
businessId
string
required
The ID of the business.

​
Request body

​
enabled
boolean
required
Set to true to enable the pay-me link, false to disable it.
​
minAmount
number
Minimum payment amount in dollars. Payers cannot submit a payment below this amount.
​
maxAmount
number
Maximum payment amount in dollars. Payers cannot submit a payment above this amount.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/pay-me-link/configure \
  --header "Authorization: Bearer <token>" \
  --header "Content-Type: application/json" \
  --data '{
    "enabled": true,
    "minAmount": 10.00,
    "maxAmount": 50000.00
  }'
POST /api/businesses/{businessId}/pay-me-link/regenerate-token Regenerates the pay-me link token, invalidating the previous link URL. Use this if the link has been shared with the wrong recipients.

​
Path parameters

​
businessId
string
required
The ID of the business.
curl --request POST \
  --url https://api.cleo-pay.com/api/businesses/biz_abc123/pay-me-link/regenerate-token \
  --header "Authorization: Bearer <token>"
Regenerating the token immediately invalidates the previous pay-me link URL. Anyone with the old link will no longer be able to use it.