​
About the API

The paywise Case Management API allows you to submit claims to our debt collection service, manage debtors, and receive status updates on ongoing mandates.

This API adheres to REST best practices, offering:

  • Predictable, resource-oriented URLs
  • JSON request bodies and responses
  • Standard HTTP response codes, authentication, and verbs

​
Important Notes:

  • Depending on the endpoint or entity being managed, some operations may be restricted due to procedural or legal limitations.
  • The paywise API supports a test mode, allowing you to simulate requests without affecting live data. The API key used to authenticate requests determines whether they are executed in live or test mode.
  • Bulk updates are not supported. Each request works on a single object.

​
What’s the Difference Between the Case Management API and the Partner API?

The paywise platform offers two APIs, each serving distinct purposes:

​
Case Management API:

  • The Case Management API focuses exclusively on facilitating the debt collection process.

​
Partner API:

  • Use the separate Partner API to create and manage paywise accounts for your client companies and onboard their users.
  • Typical use cases:
    • SaaS services that offer a user-friendly interface to their clients for managing receivables.
    • Parent companies managing groups of companies.

​
Key Points:

  • If you represent a single company and manage your own debt collection, you only need the Case Management API (documented here).
  • Partners can use the Case Management API on behalf of their client companies.

​
Authentication

All API requests must be made over HTTPS; calls over plain HTTP will fail. Requests must also include proper authentication.

​
Authentication Details:

  • The API uses Bearer tokens for authentication.
  • Separate tokens are provided for test and production environments. Start with test keys for integration.
  • Generate API keys in your paywise account.
  • Include the token in the Authorization header as follows:
$ curl -X GET https://api.paywise.de/v1/claims/ -H 'Authorization: Bearer YOUR_TOKEN'

​
Getting Started

Here’s an overview of the typical workflow for submitting claims via the API:

1

Create a Debtor

Create a Debtor. Provide all relevant information about the debtor.

2

Create a Claim

Create a Claim. Include all available information about the claim, such as an unpaid invoice.

3

Upload Documents

Upload documents to the Claim. Provide all relevant documents, such as an invoice. This step is optional but highly recommended, as it facilitates the collections process.

4

Release the Claim for Processing

Once all information is submitted, you can release the claim for processing by setting its submission_state field to released. Our team will review the claim.

5

Wait for the Claim to Be Accepted

Wait for the claim to be accepted. When accepted, the claim is added to a Mandate, and its submission_state is set to accepted. Periodically check the claim’s submission_state and mandate fields.

6

Check for Status Updates

Periodically check the claim’s status updates to track progress in the collection process.

7

Report Payments

Report payments for a claim if you receive payments directly from the debtor.

Release Notes