Treasury

List payment methods

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

Tool
filmo_payment_methods_list
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_payment_methods_list",
    "arguments": {
      "limit": 20
    }
  }
}

generated from the schema

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

Arguments

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.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data
idstring

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

namestring

Name of the payment method, as shown on documents.

typestring

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

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

isSystemboolean

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

isDefaultboolean

true for the method preselected when creating a document.

isArchivedboolean

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

createdAtstring<date-time> | null

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

updatedAtstring<date-time> | null

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

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/payment-methods.

  • Treasury

    List payment methods

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

  • Guides

    Safe writes

    An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.

  • Guides

    Errors

    A tool error is a result with isError: true and the problem in the first text block. Branch on its code.