Treasury

List payment methods

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

GET
/api/v1/payment-methods

Request examples

curl https://app.filmo.io/api/v1/payment-methods \
  --header "Authorization: Bearer $FILMO_API_KEY"
{
  "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
  }
}

Generated from the schema

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

Authorizations

Bearer API key with the scope below. treasury:read

Query parameters

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

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.

Limits: max length 200

typestring

Filter by payment method type: bank_transfer, card, cash, other or sepa_direct_debit.

Available options: bank_transfer, card, cash, other, sepa_direct_debit

typesstring[]

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.

Available options: bank_transfer, card, cash, other, sepa_direct_debit

Limits: min 1 items, max 50 items

isArchivedboolean

Filter by archive state: false for the methods currently offered, true for the archived ones. Absent means both.

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

Response

application/json

Successful response.

Response schema: PaymentMethodDto

Envelope: PaymentMethodList. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Show child attributes
data.idstring

Payment method identifier. It is what paymentMethodId expects when recording a payment.

data.namestring

Name of the payment method, as shown on documents.

data.typestring

Kind of payment method: bank_transfer, card, cash, other or sepa_direct_debit.

Available options: bank_transfer, card, cash, other, sepa_direct_debit

data.isSystemboolean

true for the methods Filmo provides to every account; false for the ones the account created.

data.isDefaultboolean

true for the method preselected when creating a document.

data.isArchivedboolean

true when the method is no longer offered; it is kept for the documents that already use it.

data.createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

data.updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

paginationobject

Opaque-cursor pagination metadata.

Show child attributes
pagination.nextCursorstring | null

Opaque cursor of the next page; null when there are no more results. Pass it as cursor in the next request.

pagination.hasMoreboolean

Whether more results exist beyond this page.

pagination.totalinteger

Number of results matching the filters across all pages. Present only when the request sets includeTotal=true.

Limits: min 0

metaobject

Additional information about the response.

Show child attributes
meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes
meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

Errors

StatusCodesMeaning
400validation_errorMalformed query or body. errors[] lists every offending field with its stable code.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

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