*REST API › Endpoint reference › Finance › Treasury*

# List payment methods

> Returns the payment methods configured in the account, sorted by name: what `paymentMethodId` expects when recording a payment.

Filter by type and archive state. Payment instructions and bank details are not published.

`GET /api/v1/payment-methods` — scope `treasury:read`

Scope: `treasury:read` · 120/min · MCP: `filmo_payment_methods_list`

## Authorizations

Bearer API key with the scope below. `treasury:read`

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | integer | No | Page size (1-500). Defaults to 50. = `50` |
| `cursor` | string | No | Opaque cursor of the page to return. Pass the value of `pagination.nextCursor` from the previous response; treat it as opaque. |
| `sort` | string | No | Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: name, type, createdAt, updatedAt. Defaults to "name". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with. |
| `type` | string | No | Filter by payment method type: bank_transfer, card, cash, other or sepa_direct_debit. `bank_transfer`, `card`, `cash`, `other`, `sepa_direct_debit` |
| `types` | string[] | No | Filter by type, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them. `bank_transfer`, `card`, `cash`, `other`, `sepa_direct_debit` |
| `isArchived` | boolean | No | Filter by archive state: false for the methods currently offered, true for the archived ones. Absent means both. |
| `includeTotal` | boolean | No | Set it to true to include `pagination.total`, the number of results that match the filters across all pages. Off by default. = `false` |

## Request examples

*List payment methods*

**cURL**

```bash
curl https://app.filmo.io/api/v1/payment-methods \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/payment-methods', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/payment-methods",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `PaymentMethodDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object[] |  |
| `data.id` | string | Payment method identifier. It is what `paymentMethodId` expects when recording a payment. |
| `data.name` | string | Name of the payment method, as shown on documents. |
| `data.type` | string | Kind of payment method: bank_transfer, card, cash, other or sepa_direct_debit. `bank_transfer`, `card`, `cash`, `other`, `sepa_direct_debit` |
| `data.isSystem` | boolean | true for the methods Filmo provides to every account; false for the ones the account created. |
| `data.isDefault` | boolean | true for the method preselected when creating a document. |
| `data.isArchived` | boolean | true when the method is no longer offered; it is kept for the documents that already use it. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 UTC; null if not recorded. |
| `data.updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC; null if not recorded. |
| `pagination` | object | Opaque-cursor pagination metadata. |
| `pagination.nextCursor` | string | Opaque cursor of the next page; null when there are no more results. Pass it as `cursor` in the next request. |
| `pagination.hasMore` | boolean | Whether more results exist beyond this page. |
| `pagination.total` | integer | Number of results matching the filters across all pages. Present only when the request sets `includeTotal=true`. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": [
    {
      "id": "payment_method_9f3a2b",
      "name": "Example payment method",
      "type": "bank_transfer",
      "isSystem": true,
      "isDefault": true,
      "isArchived": true,
      "createdAt": "2026-09-01T08:00:00.000Z",
      "updatedAt": "2026-09-01T08:00:00.000Z"
    }
  ],
  "pagination": {
    "nextCursor": "eyJvIjoyMH0",
    "hasMore": true,
    "total": 1
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/treasury/list-payment-methods  
Last updated: 2026-10-25