Skip to main content

​
Initial release

This initial release establishes the current public contracts for all three paywise APIs. The published OpenAPI references, guides, and examples describe the initial release baseline.
  • Case Management API (/v2/): submit invoice, rental, and titled orders and manage collection cases, documents, payments, statements, and webhooks.
  • Partner API (/partner/v2/): onboard and manage client companies and users, then act for those companies through the Case Management API.
  • Mahnservice API (/mahnservice/v1/): submit invoices for reminders, manage documents, report payments, and follow the reminder lifecycle through collection handover.
All three APIs provide separate production and sandbox environments and share HTTP conventions, error and retry guidance, and webhook delivery conventions. Future contract changes follow the versioning policy. Claims and debtors are stable top-level resources. Orders reference debtor UUIDs and group claims, while order responses embed debtor summaries and claim projections needed to follow a submission. Claims remain addressable by the same UUID when paywise review moves them to another order or accepts them into a mandate. Mandate activity is available through one history collection with typed related resources and attachment downloads. Existing v1 debtors, claims, mandates, payments, and Partner companies remain the same business records and retain their UUIDs. Existing cases continue from their current lifecycle state. The current APIs also preserve v1 metadata on debtors, claims, additional charges, and payments, plus events on debtors, claims, and additional charges, so historical integration context is readable without reimporting it. Partner integrations can connect existing companies, onboard new companies, manage memberships, and submit cases on behalf of connected clients. A disconnect revokes the Partner’s access without replacing the company’s underlying business records. The legacy Case Management and Partner v1 APIs are deprecated. No shutdown date has been announced, and their frozen documentation remains available in the legacy API snapshot. Existing integrations can move incrementally with the Case migration guide and Partner migration guide. Mahnservice starts with its own /mahnservice/v1/ contract and has no frozen predecessor. It is not part of the legacy Case Management and Partner v1 deprecation.