n8n Community Node

Submit orders, report payments and react to case events in n8n with the paywise community node

paywise n8n Community Node

The paywise community node connects the Case Management API to your n8n workflows. Hand overdue invoices to paywise, upload their documents, report payments you receive directly, download statements, and start workflows the moment paywise accepts an order or a case changes. The package contains two nodes:

• paywise: actions on orders, claims, debtors, cases (mandates), payments and statements. It can also be used as a tool by n8n AI agents.
• paywise Trigger: starts a workflow when paywise sends a webhook event.

Installation

1. In n8n, open Settings → Community Nodes and click Install.
2. Enter the package name @paywise/n8n-nodes-paywise and confirm.

See the n8n documentation on community nodes for details, for example on queue mode. Releases are published from GitHub Actions with a signed provenance statement; the source is on GitHub.

Connect your paywise account

1. In paywise, open Für Entwickler and create an API key.
2. In n8n, create a Paywise Case Management API credential.
3. Choose the Environment that matches the key and paste the key. A key starting with pw_sbx_ belongs to the sandbox, every other key to your live account.
4. Save. n8n tests the key and reports whether the connection works.

Build and test new workflows with a sandbox key first, then switch the credential to a production key.

Operations

Resource	Operations
Order	Create (optionally submit right away), Get, Get Many, Update, Delete draft, Submit, Withdraw
Claim	Create in a draft order, Get, Get Many, Update, Delete
Claim Document	Upload from a binary field, Get, Get Many, Download, Delete
Debtor	Create (consumer or business), Get, Get Many, Update
Mandate	Get (optionally with history), Get Many, Get History, Get Documents, Download Document
Payment	Report (on a claim or case), Get, Get Many, Delete a claim payment
Statement	Get, Get Many, Download (PDF or Excel)
Single Mandate Statement	Get, Get Many, Download
API Key Info	Company, environment and scopes of the key in use

An order bundles the claims against one debtor. Create it as a draft with its claims, upload the documents to the claims, then submit it. Once paywise accepts the order, it becomes a case (mandate) that you can follow with the trigger or the Mandate operations. See Orders and Claims for what paywise checks before it accepts an order.

The Claims (JSON) field of Order → Create and the Claim (JSON) field of Claim → Create take claim objects as described in the API reference. Documents can be PDF, JPEG or PNG files of up to 10 MiB. Downloads put the file into an n8n binary field for later steps.

Trigger

The paywise Trigger registers a webhook for the selected events when you activate the workflow and removes it when you deactivate it. Every delivery is checked against the webhook’s signing secret; deliveries with an invalid signature are rejected.

Event	Fires when
Order Submitted, Accepted, Rejected, Withdrawn, Expired	The order reaches that state. Order Accepted includes the new case.
Mandate Created, State Changed	A case is created, or its legal stage, processing or payment state changes.
Mandate Status Update Published, Balance Updated	paywise publishes a status update, or the open balance changes.
Order Message Created, Mandate Message Created	A message from you to paywise is received.
Request to Client Created, Answered	paywise asks you a question, or it is answered.
Payment Reported	A payment is reported on a claim or case.
Statement Published, Cancelled	A collective statement (Sammelabrechnung) is published or cancelled.
Single Mandate Statement Published, Cancelled	The statement of a single case (Einzelabrechnung) is published or cancelled.

Events carry IDs and links, not the full record. Add a paywise node after the trigger to read the order, case or statement. See Webhook events for the payload of each event.

paywise only delivers to publicly reachable HTTPS URLs. Your n8n instance must be reachable from the internet; a company can register up to 20 webhooks.

Retries and errors

• Create, upload, report, submit and withdraw requests carry an idempotency key. With Retry On Fail, a repeated request returns the original result instead of creating a second order, claim or payment.
• Under Options → Idempotency Key you can set your own key, for example your invoice number, to also prevent duplicates across workflow runs for 24 hours.
• Error messages name the field that needs attention, for example claims[0].principal_amount, and include the paywise request ID for support.

Usage examples

Hand over an overdue invoice

1. Trigger: your accounting system’s “invoice overdue” event
2. paywise → Debtor → Create with the customer’s name, address and customer number
3. paywise → Order → Create with the debtor ID and the invoice as a claim
4. paywise → Claim Document → Upload with the invoice PDF
5. paywise → Order → Submit

Report a payment the debtor made to you

1. Trigger: your bank or payment provider’s “payment received” event
2. paywise → Payment → Report on the case, with amount and value date

Keep your CRM up to date

1. paywise Trigger on Order Accepted and Mandate State Changed
2. paywise → Mandate → Get with the case ID from the event
3. Update the customer record in your CRM with the case reference and state

File statements automatically

1. paywise Trigger on Statement Published
2. paywise → Statement → Download
3. Save the file to your document storage or send it to your accountant

Workflows built with version 0.x

Version 1.0 of the package replaces 0.x. Existing workflows keep running unchanged: their nodes stay on the previous node version and keep using the previous Paywise API credential. New paywise nodes use the current version. To move a workflow, replace its paywise nodes with new ones, connect a Paywise Case Management API credential, test it with a sandbox key and activate it.

0.x	1.0
Claim → Create, Create and Release	Order → Create (with Submit Order), or Order → Create, Claim Document → Upload, Order → Submit
Claim → Release	Order → Submit
Claim → Upload Document	Claim Document → Upload
Act on behalf of client	An API key of the company itself

The partner operations of 0.x (companies, users, user invites) are not part of 1.0; use the Partner API directly.

Support

If you have questions about the paywise n8n node, contact [e-mail].