GET /v1/bank-accounts — List Bank Accounts

Retrieve all bank accounts linked to your business. The response contains every account regardless of its current verification status, so you can use this endpoint to audit your connected accounts or present a selection UI to your users.

HTTP Request

GET https://api.cleo-pay.com/v1/bank-accounts

Authentication

Include your bearer token on every request:

Authorization: Bearer <token>

Request Parameters

This endpoint does not accept any query parameters, path parameters, or a request body.

Response Fields

items

array

required

An array of bank account objects. Returns an empty array if no accounts are linked to your business.

Show BankAccount object

string

required

Unique identifier for the bank account.

status

string

required

Current verification status of the account. One of:

pending_verification — micro-deposits have been initiated and are awaiting confirmation.
verified — account is verified and ready to use for payments.
unverified — verification failed because the maximum number of attempts was exceeded.
removed — account has been deleted.

type

string

required

The bank account type. Either checking or savings.

connectionType

string

required

How the account was connected. Either manual (linked via the API) or plaid. The API only creates manual accounts.

name

string | null

The display name assigned to this account.

institutionName

string | null

The name of the financial institution.

accountNumberLast4

string | null

The last four digits of the account number.

routingNumberLast4

string | null

The last four digits of the routing number.

isDefault

boolean

required

Whether this account is the default account for your business.

microDepositsInitiatedAt

datetime | null

The timestamp at which micro-deposits were initiated, or null if not yet started.

microDepositsCompletedAt

datetime | null

The timestamp at which micro-deposits landed in the account. Verification can be attempted from this point forward.

verificationAttempts

number

required

The number of failed verification attempts made so far. The maximum is 3.

Example Request

curl --request GET \
  --url https://api.cleo-pay.com/v1/bank-accounts \
  --header 'Authorization: Bearer <token>'

Example Response

{
  "items": [
    {
      "id": "ba_01j9kxm2p4fghe3t7q8wnvd5rc",
      "status": "verified",
      "type": "checking",
      "connectionType": "manual",
      "name": "Primary Operating Account",
      "institutionName": "Chase",
      "accountNumberLast4": "4321",
      "routingNumberLast4": "0001",
      "isDefault": true,
      "microDepositsInitiatedAt": "2024-10-01T10:00:00Z",
      "microDepositsCompletedAt": "2024-10-03T08:30:00Z",
      "verificationAttempts": 0
    },
    {
      "id": "ba_02k8lzn3q5gihf4u8r9xowe6sd",
      "status": "pending_verification",
      "type": "savings",
      "connectionType": "manual",
      "name": "Reserve Savings",
      "institutionName": "Bank of America",
      "accountNumberLast4": "8765",
      "routingNumberLast4": "0002",
      "isDefault": false,
      "microDepositsInitiatedAt": "2024-10-05T14:22:00Z",
      "microDepositsCompletedAt": null,
      "verificationAttempts": 0
    }
  ]
}

This endpoint is not paginated. All bank accounts linked to your business are returned in a single response. If your business has many accounts, consider filtering client-side by status to surface only the accounts relevant to your workflow.

Payables

Bank Accounts

Contacts

Payments

GET /v1/bank-accounts — List Bank Accounts

HTTP Request

Authentication

Request Parameters

Response Fields

Example Request

Example Response

​HTTP Request

​Authentication

​Request Parameters

​Response Fields

​Example Request

​Example Response

HTTP Request

Authentication

Request Parameters

Response Fields

Example Request

Example Response