payments — full tool reference
Transactions, invoices and payments.
| Endpoint | https://payments.mcp.devfellowship.com/mcp |
| Package | packages/dfl-mcp-payments |
| Tools | 8 |
| Tool | Description |
|---|---|
list_transactions | List all transactions with optional filters. Requires finance/admin/owner role. |
get_transaction | Get a specific transaction by ID. Requires finance/admin/owner role. |
create_transaction | Create a new transaction. Requires finance/admin/owner role. |
update_transaction | Update an existing transaction. Requires finance/admin/owner role. |
delete_transaction | Delete a transaction by ID. Requires finance/admin/owner role. |
list_payments | List fellow payments (invoices) by state, with amount, recipient, and ids. Defaults to the actionable states submitted (awaiting approval), approved (awaiting movement), and payment_requested (Awaiting Woovi). Read-only. Requires finance/admin/owner role (enforced by middleware). |
get_payment | Get a single payment (invoice) by id, including its line items and the full transition-timestamp history (submitted/reviewed/approved/rejected/paid). Read-only. Requires finance/admin/owner role (enforced by middleware). |
advance_payment | Move ONE payment (invoice) forward by exactly one transition: submitted→approved (approve) or approved→payment_requested (dispatch Woovi PIX). SUPER-ADMIN ONLY (IAM level >= 100). Never batches; returns before/after state. The approved→payment_requested step moves real money and requires confirm=true; it reuses the same Woovi edge function the dfl-payments UI uses. |
list_transactions
Section titled “list_transactions”List Transactions
List all transactions with optional filters. Requires finance/admin/owner role.
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | no | Maximum number of transactions to return (default: 50, max: 100) |
offset | number | no | Number of transactions to skip (for pagination) |
target_id | string | no | Filter by target member ID |
project_id | string | no | Filter by project ID |
status | enum | no | Filter by transaction status One of: pending, processing, completed, failed, canceled. |
get_transaction
Section titled “get_transaction”Get Transaction
Get a specific transaction by ID. Requires finance/admin/owner role.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Transaction ID (UUID) |
create_transaction
Section titled “create_transaction”Create Transaction
Create a new transaction. Requires finance/admin/owner role.
| Parameter | Type | Required | Description |
|---|---|---|---|
target_id | string | yes | Target member ID (UUID) |
total | number | yes | Transaction total amount |
project_id | string | no | Associated project ID (UUID) |
status | enum | no | Transaction status (default: pending) One of: pending, processing, completed, failed, canceled. |
notes | string | no | Transaction notes |
update_transaction
Section titled “update_transaction”Update Transaction
Update an existing transaction. Requires finance/admin/owner role.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Transaction ID (UUID) |
target_id | string | no | Target member ID (UUID) |
total | number | no | Transaction total amount |
project_id | string | no | Associated project ID (UUID), null to remove |
status | enum | no | Transaction status One of: pending, processing, completed, failed, canceled. |
notes | string | no | Transaction notes, null to remove |
delete_transaction
Section titled “delete_transaction”Delete Transaction
Delete a transaction by ID. Requires finance/admin/owner role.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Transaction ID (UUID) |
list_payments
Section titled “list_payments”List Payments (Invoices)
List fellow payments (invoices) by state, with amount, recipient, and ids. Defaults to the actionable states submitted (awaiting approval), approved (awaiting movement), and payment_requested (Awaiting Woovi). Read-only. Requires finance/admin/owner role (enforced by middleware).
| Parameter | Type | Required | Description |
|---|---|---|---|
statuses | enum[] | no | Filter by one or more states. Default: [“submitted”,“approved”,“payment_requested”]. |
fellow_user_id | string | no | Filter by a specific fellow (UUID). |
reference_month | string | no | Filter by reference month, e.g. “2026-06”. |
limit | number | no | Max rows (default 100, max 200). |
get_payment
Section titled “get_payment”Get Payment (Invoice) detail
Get a single payment (invoice) by id, including its line items and the full transition-timestamp history (submitted/reviewed/approved/rejected/paid). Read-only. Requires finance/admin/owner role (enforced by middleware).
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Invoice ID (UUID). |
advance_payment
Section titled “advance_payment”Advance Payment (one transition forward)
Move ONE payment (invoice) forward by exactly one transition: submitted→approved (approve) or approved→payment_requested (dispatch Woovi PIX). SUPER-ADMIN ONLY (IAM level >= 100). Never batches; returns before/after state. The approved→payment_requested step moves real money and requires confirm=true; it reuses the same Woovi edge function the dfl-payments UI uses.
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | yes | Invoice ID (UUID) to advance. |
confirm | boolean | no | Required (true) for the money-moving approved→payment_requested transition. Ignored for submitted→approved. |
expected_status | string | no | Optional safety check: the status you believe the invoice is in. If it differs from the live status, the call is rejected (no write). |