Skip to main content
Scope: payments:initiate, bank-accounts:read or bank-accounts:write Lists the Cleo Pay balance and the bank linked to Cleo Pay (when the business has a Cleo Pay account) and each verified Dwolla bank, side by side. The default rail’s sources come first. Nothing is hidden because of the default rail.

​
Response

200 with { items }.
​
string
balance, linked_bank, or a Dwolla bank account id.
​
string
DWOLLA or CLEO_PAY.
​
string
balance, linked_bank or bank (a Dwolla bank).
​
string | null
The bank’s name, or Cleo Pay balance.
​
string | null
Last 4 digits of the bank account.
​
integer | null
What the balance can spend now. Balance only, and null unless the key can read payments or the balance.
​
boolean
The source a payment uses when it names nothing.
​
boolean
Whether a payment can be funded from this source now.
​
string | null
Why canPay is false: cleo_pay_not_ready, no_linked_bank, bank_funding_unavailable, bank_reauth or rail_not_ready. New reasons may be added.
​
string | null
A Cleo web page where your user fixes the block.
​
object
The fields to send on POST /v1/payments: paymentRail, and fundingSource or bankAccountId. It never includes achAuthorizationAccepted; add that yourself after your user accepts the ACH debit authorization.
The linked bank currently lists with canPay: false and unavailableReason: "bank_funding_unavailable", because paying from it is not available through the API yet. See Funding sources for an example and the rail rules.