Two payment modes
Every payment must reference exactly one of the following — but not both:You cannot specify both
payableId and contactId in the same request. Choose the mode that matches your workflow.Payment status lifecycle
The standard happy path is:
pending → scheduled → processing → completed
If a contact doesn’t have a bank account on file when you send a payment, the payment enters
held status rather than failing immediately. As soon as the contact’s bank account is added, the payment proceeds automatically.Clearing speeds
Theclearing field controls how quickly the ACH transfer is processed.
Scheduling payments
By default, payments are processed as soon as possible. To send a payment on a future date, include thescheduledAt field:
- Format:
YYYY-MM-DD - Minimum value: Tomorrow’s date (same-day scheduling is not supported)
- Execution time:
9:00 AM New York timeon the scheduled date - Constraint: Must fall within a valid business window
Partial payments
When paying a payable (payableId), the amountCents field is optional:
- If omitted: Cleo Pay defaults to the payable’s full
remainingAmountCents, paying the invoice in full. - If specified: Only that amount is paid, and the payable’s
remainingAmountCentsis reduced accordingly. You can send additional payments later until the balance reaches zero.
contactId), amountCents is required.
Large payment splitting
For very large payment amounts, Cleo Pay may automatically split the transfer into multiplePayment objects whose amounts sum to your requested total. This is handled transparently — your single API request may result in an array of payments in the response.
Always iterate over the payments array in the response rather than assuming a single payment object.
Example: pay a payable
Example: pay a contact directly
CreatePaymentResponse
The response always includes apayableId (if applicable) and a payments array. Even when a single payment is created, the result is wrapped in this array.
Next steps
- Payables — understand how payment status maps back to invoice tracking.
- Contacts — ensure your contact is
paymentReadybefore initiating a payment. - Bank Accounts — verify your funding account before sending funds.