Add money to the balance

Not available through the API yet. This route answers 403 feature_unavailable until Cleo turns partner bank funding on. Your user can add money in the Cleo web app. The contract below is what the route accepts once it is on.

POST /v1/balance/deposits

Scope: balance:transfer · Idempotency-Key: required

integer

required

1 to

50,000 (100 to 5000000).

boolean

required

Must be true: your user accepted the ACH debit authorization for this pull from the linked bank. Cleo records your API key and IP address with it.

curl -X POST https://api.stg.cleo-pay.com/v1/balance/deposits \
  --header "Authorization: Bearer $CLEO_API_KEY" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d" \
  --data '{ "amountCents": 1000000, "achAuthorizationAccepted": true }'

Response

201:

string

The deposit. It appears as a pending deposit in GET /v1/balance/transactions.

integer

string

processing, succeeded, failed, canceled or returned.

string | null

same_day or standard, chosen by Cleo. You cannot ask for same-day.

string | null

When the money should be in the balance.

Errors

Code	When
`feature_unavailable`	Partner bank funding is not on, or the business has no Cleo Pay balance.
`validation_error`	`achAuthorizationAccepted` is not `true`, or the amount is out of range.
`setup_required`	No Cleo Pay account, or no bank linked to it.
`payments_locked`, `setup_incomplete`	The business cannot move money yet.
`payment_unconfirmed`	The deposit may have started. Check `GET /v1/balance/transactions` before you use a new key.

Business

Payables

Payments

Contacts

Invoices

Balance

Bank Accounts

Webhook Endpoints

Add money to the balance

Response

Errors

​Response

​Errors

Response

Errors