List Payment Means

get/v1/payment-means

Returns a cursor-paginated list of payment instruments (bank accounts, cards, checks) linked to companies or people in the active workspace. Read only, no side effects. For example, Foldspace AI's Mercury checking instrument. ## Filtering & sorting Filter via `POST /v1/records/query` (root `payment_means`) or the `filters` model; operators are gated by each field's data type. See [Filtering & sorting](../filtering-and-sorting). **Filterable fields** | Field | Type | Allowed operators | |---|---|---| | `composite_debtor_transactions_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_invoice_payment_means_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_payment_means_summary` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `composite_transactions_list` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `created_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `deleted_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | | `name` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `payment_means_external_id` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `payment_means_id` | text | `contains` `eq` `neq` `starts_with` `ends_with` `is_null` `is_not_null` | | `pk` | number | `eq` `neq` `gt` `gte` `lt` `lte` `is_null` `is_not_null` | | `updated_at` | date | `eq` `lt` `gt` `is_null` `is_not_null` | **Sortable fields:** `composite_debtor_transactions_list`, `composite_invoice_payment_means_list`, `composite_payment_means_summary`, `composite_transactions_list`, `created_at`, `deleted_at`, `name`, `payment_means_external_id`, `payment_means_id`, `pk`, `updated_at` (via `orderBy` / `sort`, `asc`|`desc`).

Requires a bearer token: Authorization: Bearer <token>.

Query parameters

Name	Type	Required	Description
cursor	string	No	Opaque pagination cursor returned as links.next on the previous page. Omit to fetch the first page.e.g. eyJwayI6MTI4N30
limit	integer	No	Maximum number of records to return per page (1 to 200, defaults to 50).e.g. 50
orderBy	string	No	Field to sort by, using the records dot path or column name (e.g. created_at).e.g. created_at
direction	string	No	Sort direction for orderBy. Defaults to desc.e.g. desc
workspaceId	string <uuid>	No	Explicit workspace scope. The authenticated user must hold an active membership in this workspace. Defaults to the session workspace when omitted.e.g. a1b2c3d4-0000-4000-8000-000000000001

Request

cURL

curl -X GET https://api.wellapp.ai/v1/payment-means \
  -H "Authorization: Bearer $WELL_API_TOKEN"

Responses

200 — A page of payment means.

{
  "data": [
    {
      "type": "payment_means",
      "id": "44444444-0000-4000-8000-0000000000e1",
      "attributes": {
        "name": "Mercury Checking ****4471",
        "payment_means_external_id": "pm_mercury_4471",
        "created_at": "2026-01-12T18:02:00Z",
        "updated_at": "2026-04-27T09:15:00Z",
        "deleted_at": null
      },
      "relationships": {
        "account": {
          "data": {
            "type": "Account",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "card": {
          "data": {
            "type": "Card",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "check": {
          "data": {
            "type": "Check",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "company": {
          "data": {
            "type": "Company",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "people": {
          "data": {
            "type": "People",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        },
        "sourceWorkspaceConnector": {
          "data": {
            "type": "WorkspaceConnector",
            "id": "00000000-0000-4000-8000-000000000001"
          }
        }
      }
    }
  ],
  "meta": {
    "total": 1,
    "count": 1
  },
  "links": {
    "next": null
  }
}

400 — Bad request

{
  "code": "BAD_REQUEST",
  "status": 400,
  "title": "Bad Request",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

401 — Unauthorized

{
  "code": "UNAUTHORIZED",
  "status": 401,
  "title": "Unauthorized",
  "message": "See title.",
  "meta": {
    "trace_id": "a1b2c3",
    "log_id": "a1b2c3"
  }
}

This resource's related objects (the ones you can include) and how to filter or sort on each:

Relationship	Cardinality	Filter on a field	Sort by a field
`workspace`	to-one (Workspace)	`{ "workspace": { "field_name": { "_eq": … } } }`	`"field": "workspace.field_name"` ✅
`account`	to-one (Account)	`{ "account": { "field_name": { "_eq": … } } }`	`"field": "account.field_name"` ✅
`card`	to-one (Card)	`{ "card": { "field_name": { "_eq": … } } }`	`"field": "card.field_name"` ✅
`check`	to-one (Check)	`{ "check": { "field_name": { "_eq": … } } }`	`"field": "check.field_name"` ✅
`company`	to-one (Company)	`{ "company": { "field_name": { "_eq": … } } }`	`"field": "company.field_name"` ✅
`people`	to-one (People)	`{ "people": { "field_name": { "_eq": … } } }`	`"field": "people.field_name"` ✅
`sourceWorkspaceConnector`	to-one (WorkspaceConnector)	`{ "sourceWorkspaceConnector": { "field_name": { "_eq": … } } }`	`"field": "sourceWorkspaceConnector.field_name"` ✅

Replace field_name with any field of the related object. See its object-reference page for the full field list.

Filter by a to-one relation (and sort by it):

{
  "root": "payment_means",
  "whereClause": { "workspace": { "field_name": { "_ilike": "%acme%" } } },
  "orderBy": { "field": "workspace.field_name", "direction": "asc" }
}

Query parameters

Request

Responses

Filtering & sorting on related objects