# paywise Knowledge Center

> paywise is an established digital debt collection platform based in Germany, serving tens of thousands of clients of all sizes — from sole proprietors and SMEs to large enterprises. With a Trustpilot rating of 4.7, paywise is one of the highest-rated debt collection companies in Germany. This documentation covers the paywise APIs, integration guides, and user documentation. paywise provides two distinct APIs: the **Case Management API** for managing the debt collection process, and the **Partner API** for managing client companies and users as an integration partner.

## Case Management API

The Case Management API enables companies to manage the entire debt collection process programmatically — from creating claims and debtors to tracking mandates, payments, and statements. It uses Bearer token authentication with separate test and production environments.

- [Introduction](https://docs.paywise.de/api-docs/case-management-api/introduction.md): Welcome to the paywise Case Management API — overview, authentication, environments, and getting started
- [Release Notes](https://docs.paywise.de/api-docs/case-management-api/releasenotes.md): The paywise Case Management API is regularly updated with new and improved features

### Claims

- [List Claims](https://docs.paywise.de/api-docs/case-management-api/claims/list-claims.md): List all claims for the authenticated company
- [Create a Claim](https://docs.paywise.de/api-docs/case-management-api/claims/create-a-claim.md): Create a new debt collection claim with debtor, amount, and due date information
- [Retrieve a Claim](https://docs.paywise.de/api-docs/case-management-api/claims/retrieve-a-claim.md): Retrieve details of a specific claim by ID
- [Delete an Unreleased Claim](https://docs.paywise.de/api-docs/case-management-api/claims/delete-an-unreleased-claim.md): Delete a claim that has not yet been released for processing
- [Release Claim for Processing](https://docs.paywise.de/api-docs/case-management-api/claims/release-claim-for-processing.md): Release a claim to start the debt collection process
- [Upload a Document to a Claim](https://docs.paywise.de/api-docs/case-management-api/claims/upload-a-document-to-a-claim.md): Upload supporting documents to a claim

### Debtors

- [List Debtors](https://docs.paywise.de/api-docs/case-management-api/debtors/list-debtors.md): List all debtors for the authenticated company
- [Create a Debtor](https://docs.paywise.de/api-docs/case-management-api/debtors/create-a-debtor.md): Create a new debtor with personal and contact information
- [Retrieve a Debtor](https://docs.paywise.de/api-docs/case-management-api/debtors/retrieve-a-debtor.md): Retrieve details of a specific debtor by ID
- [Add Address to a Debtor](https://docs.paywise.de/api-docs/case-management-api/debtors/add-address-to-a-debtor.md): Add an address to an existing debtor
- [Add Bank Account to a Debtor](https://docs.paywise.de/api-docs/case-management-api/debtors/add-bank-account-to-a-debtor.md): Add a bank account to an existing debtor
- [Add Debtor Communication Channel](https://docs.paywise.de/api-docs/case-management-api/debtors/add-debtor-communication-channel.md): Add a communication channel (email, phone) to a debtor

### Mandates

- [List Mandates](https://docs.paywise.de/api-docs/case-management-api/mandates/list-mandates.md): List all mandates for the authenticated company
- [Retrieve a Mandate](https://docs.paywise.de/api-docs/case-management-api/mandates/retrieve-a-mandate.md): Retrieve details of a specific mandate by ID
- [Archive a Mandate](https://docs.paywise.de/api-docs/case-management-api/mandates/archive-a-mandate.md): Archive a mandate
- [List Status Updates](https://docs.paywise.de/api-docs/case-management-api/mandates/list-status-updates.md): List status updates for a mandate
- [List Requests to Client for a Mandate](https://docs.paywise.de/api-docs/case-management-api/mandates/list-requests-to-client-for-a-mandate.md): List requests to client (Rückfragen) for a specific mandate
- [Get Request to Client Details](https://docs.paywise.de/api-docs/case-management-api/mandates/get-request-to-client-details.md): Retrieve details of a specific request to client
- [Submit Request to Client Answer](https://docs.paywise.de/api-docs/case-management-api/mandates/submit-request-to-client-answer.md): Submit an answer to a request to client
- [Upload Document to Request to Client Answer](https://docs.paywise.de/api-docs/case-management-api/mandates/upload-document-to-request-to-client-answer.md): Upload a document as part of a request to client answer

### Payments

- [List Payments](https://docs.paywise.de/api-docs/case-management-api/payments/list-payments.md): List all payments for the authenticated company
- [Create a Payment](https://docs.paywise.de/api-docs/case-management-api/payments/create-a-payment.md): Record a payment received for a claim
- [Retrieve a Payment](https://docs.paywise.de/api-docs/case-management-api/payments/retrieve-a-payment.md): Retrieve details of a specific payment by ID

### Statements

- [Statements Overview](https://docs.paywise.de/api-docs/case-management-api/statements/overview.md): High-level guide to the Statements endpoints
- [List Statements](https://docs.paywise.de/api-docs/case-management-api/statements/list-statements.md): List all statements for the authenticated company
- [Retrieve a Statement](https://docs.paywise.de/api-docs/case-management-api/statements/retrieve-a-statement.md): Retrieve details of a specific statement by ID
- [List Mandate Details for Statement](https://docs.paywise.de/api-docs/case-management-api/statements/list-mandate-details-for-statement.md): List mandate-level details for a specific statement

### Info

- [Get User Info](https://docs.paywise.de/api-docs/case-management-api/info/get-user-info.md): Retrieve information about the authenticated user and their permissions

## Partner API

The Partner API is designed for integration partners who want to incorporate paywise debt collection services into their own systems or manage groups of companies. Typical use cases include: integrating debt collection into ERP systems (e.g. SAP, Oracle), CRM systems (e.g. Salesforce, HubSpot), or accounting and invoicing software — as well as managing a corporate structure where a parent company or holding oversees multiple subsidiaries, each with their own paywise accounts and users. While the Case Management API handles the debt collection process itself, the Partner API focuses on account and user lifecycle management: creating client companies on paywise, onboarding users, and managing organizational structures. Companies must be fully onboarded via the Partner API before they can use the Case Management API. Partners can also use the Case Management API on behalf of client companies by including an `X-User-Id` header.

- [Introduction](https://docs.paywise.de/api-docs/partner-api/introduction.md): Welcome to the paywise Partner API — overview, use cases, and differences from the Case Management API
- [Get Started](https://docs.paywise.de/api-docs/partner-api/getstarted.md): Your first steps with the paywise Partner API — authentication, environments, and onboarding workflows
- [Entities](https://docs.paywise.de/api-docs/partner-api/entities.md): The main entities used within the Partner API — Companies, Users, and User Invites
- [API-Only Onboarding](https://docs.paywise.de/api-docs/partner-api/onboarding-api-only.md): Onboarding users via API only — step-by-step guide for fully automated partner integrations
- [Web Flow Onboarding](https://docs.paywise.de/api-docs/partner-api/onboarding-web-flow.md): Guide to onboarding users with the Onboarding Web Flow — a hybrid approach using paywise-hosted UI

### Companies

- [List Companies](https://docs.paywise.de/api-docs/partner-api/companies/list-companies.md): List all companies managed by the authenticated partner
- [Create Company](https://docs.paywise.de/api-docs/partner-api/companies/create-company.md): Create a new client company on paywise
- [Get Company](https://docs.paywise.de/api-docs/partner-api/companies/get-company.md): Retrieve details of a specific company by ID
- [Update Company](https://docs.paywise.de/api-docs/partner-api/companies/update-company.md): Update details of an existing company

### Users

- [List Users](https://docs.paywise.de/api-docs/partner-api/users/list-users.md): List all users managed by the authenticated partner
- [Create User](https://docs.paywise.de/api-docs/partner-api/users/create-user.md): Create a new user for a client company
- [Get User](https://docs.paywise.de/api-docs/partner-api/users/get-user.md): Retrieve details of a specific user by ID

### User Invites

- [Create User Invite](https://docs.paywise.de/api-docs/partner-api/userinvites/create-user-invite.md): Create an invitation for a new user to join a company
- [Get User Invite](https://docs.paywise.de/api-docs/partner-api/userinvites/get-user-invite.md): Retrieve details of a specific user invite by ID
- [Get Onboarded User](https://docs.paywise.de/api-docs/partner-api/userinvites/get-onboarded-user.md): Retrieve the user created from a completed onboarding invite

### Info

- [Get Token Info](https://docs.paywise.de/api-docs/partner-api/info/get-token-info.md): Retrieve information about the authenticated partner token

## Integrations

paywise can be integrated into automation platforms without writing code.

- [Introduction](https://docs.paywise.de/integrations/introduction.md): Overview of available paywise integrations
- [n8n Community Node](https://docs.paywise.de/integrations/n8n-node.md): Integrate paywise APIs into your n8n workflows using the community node
- [Zapier](https://docs.paywise.de/integrations/zapier.md): Connect paywise APIs to your Zapier workflows

## Optional

- [Anwenderdokumentation](https://docs.paywise.de/user-docs/overview.md): Fachliche Dokumentation für die Arbeit mit paywise (German user documentation)
- [Account- und Nutzerverwaltung](https://docs.paywise.de/user-docs/verwaltung/multi-user.md): Verwalten Sie Benutzer und Accounts in paywise