Retry a failed payment - Cleo Pay

POST /v1/payables/{payableId}/retry-payment

Scope: payments:initiate · Idempotency-Key: required Retries a bill whose paymentStatus is failed. The request has no body and takes no rail or source: the retry runs on the failed payment’s rail, never on the business’s current default.

string

required

The bill whose payment failed.

curl -X POST https://api.stg.cleo-pay.com/v1/payables/b1e2c3d4-5f6a-4b8c-9d0e-1f2a3b4c5d6e/retry-payment \
  --header "Authorization: Bearer $CLEO_API_KEY" \
  --header "Idempotency-Key: 8e9f0a1b-2c3d-4e4f-8a5b-6c7d8e9f0a1b"

Response

201 with the same shape as POST /v1/payments: { payableId, payments }.

Errors

Code	When
`payment_not_retryable`	The bill’s payment did not fail. `details.status` is the bill’s payment status. Also returned when the retry would pull from the Cleo Pay linked bank again: that needs your user’s ACH debit authorization, so pay it with `POST /v1/payments` (`paymentRail: "CLEO_PAY"`, `fundingSource: "BANK"`, `achAuthorizationAccepted: true`).
`validation_error`	The bill reached its retry limit. Contact Cleo support.
`not_found`	The bill is not the business’s.
`insufficient_balance`, `payments_locked`, `setup_incomplete`, `setup_required`	As on `POST /v1/payments`.
`payment_unconfirmed`	The retry may have started a payment. Every retry with this key answers `409 payment_unconfirmed`. Check `GET /v1/payments?payableId=...` before you use a new key.