​
About the API

Use the Case Management API to submit claims to our debt collection service, manage debtors and get status updates on running mandates.

The paywise Case Management API is based on REST best practices. Our API tries to provide predictable resource-oriented URLs, accepts JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Depending on the endpoint and/or the entity that is managed with this endpoint, some operations may not be available due to procedural and/or legal restrictinos.

You can use the paywise API in test mode, which doesn’t affect your live data. The API key you use to authenticate the request determines whether the request is live mode or test mode.

paywise APIs don’t support bulk updates. You can work on only one object per request.

​
Authentication

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

All API endpoints are authenticated using Bearer tokens.

  • There are separate token types for test and production environments. Always start with test keys first.
  • Generate a new API Key in your Account
  • Use the Authorization: Bearer YOUR_TOKEN in your request header.
$ curl -X GET https://api.paywise.de/v1/claims/ -H 'Authorization: Bearer YOUR_TOKEN'

​
Getting started

A typical workflow to get started submitting claims looks like this:

1

Create a Debtor

Create a Debtor. In this step you provide all relevant information on your customer i.e. the debtor

2

Create a Claim

Create a Claim. Provide all available information on the claim that you wish to collect. Typically, this is your unpaid invoice.

3

Upload Documents

Upload documents to the Claim. In this step, you provide all relevante documents on this claim, typically the invoice document. While this step remains optional, it is highly encouraged to upload a document to a claim, as this will facilitate the collections process.

4

Release the Claim for Processing

Once all infomrmation is passed to us, you cann Release the Claim for Processing by setting the claim’s submission_state field to released. Now our team will start reviewing your claim.

5

Wait for the Claim to be accepted

Wait for the claim to be accepted. When a claim is accepted, it is added to a Mandate and the claim’s submission_state is set to accepted. To do so, periodically check the claim’s submission_state and mandate fields.

6

Check for Status updates

Periodically check the claim’s status updates to get informed about any progress in the claim collection process

7

Report payments

Report payments for a claim which you directly received from your debtor.

Release Notes