Skip to main content
paywise exposes three complementary APIs with one set of HTTP conventions. Start with the API that owns the first resource your integration needs, then add another API only when your workflow crosses that boundary.

​
Choose an API

Case Management API

Submit collection orders for one company, attach claims and documents, and follow mandates, messages, payments, and statements.

Partner API

Onboard and manage multiple companies and their memberships before acting for those companies through the Case Management API.

Mahnservice API

Submit invoices into pre-collection dunning (Mahnwesen), release them, report payments, and follow the dunning ladder and sent notices.

​
What to do with which API

The products chain naturally: an invoice that stays unpaid through the Mahnservice dunning ladder ends in the handover to collection, where the Case Management API takes over. A Partner integration wraps either product for many companies at once. One credential model covers all three: keys are bound to a company and work for both the Case Management and Mahnservice APIs. A Partner key manages its companies through /partner/v2/ and selects one of them per Case request with the X-On-Behalf-Of-Company header — that header is only for Partner keys calling /v2/, nowhere else.

​
First request in five minutes

Sign in to the production portal, enter the sandbox (Für Entwickler → Zur Sandbox), and issue a sandbox key under Für Entwickler. No separate sandbox admission or setup by paywise is required. Then read back what that key is:
  • 200 with a JSON body naming your company and "environment": "sandbox" — the response also carries X-Paywise-Environment: sandbox. Host and key agree; continue with a quickstart.
  • 401 — host and key do not belong together: a pw_sbx_ key was sent to api.paywise.de, a production key to the sandbox host, or the key was mistyped or revoked. Fix the pairing; nothing else recovers a 401.
If you get an HTML page instead of JSON, you called the portal host (sandbox.paywise.de) rather than the API host. The sandbox troubleshooting table covers the other usual mix-ups.

​
Build your first integration

  1. Obtain separate credentials for sandbox and production — both are issued by your own developers under Für Entwickler, sandbox keys in the sandbox portal and production keys in the production portal. Case Management and Mahnservice are fully self-serve. For the Partner API, choose Partner werden, submit the Partner-API anfragen form, and wait for paywise sign-off once; Partner key issuance is self-serve after that.
  2. Call the applicable credential-info operation to verify the environment, principal, and company context.
  3. Follow the Case Management quickstart, the Partner quickstart, or the Mahnservice quickstart.
  4. Add idempotent writes, synchronization, and webhooks before moving traffic to production.
For example, inspect a direct Case credential before creating resources:
If this call returns 401, confirm that the credential belongs to the host you called; sandbox and production credentials are not interchangeable. These credential-info operations require authentication. When a Partner credential calls Case credential info, it must also select an entitled company with X-On-Behalf-Of-Company. If a correctly authenticated call still returns 403, record X-Paywise-Request-Id and contact paywise support. See the Case credential-info reference and Partner credential-info reference.

​
Shared behavior

​
Migrating an existing integration

The current contracts are breaking migrations from v1. Review the complete checklist for the API you use before changing base paths or credentials:

​
Legacy APIs

Existing legacy integrations remain documented separately. Use the legacy API landing page to maintain them; build new integrations against the current contracts described here.