Paywise Wissensdatenbank

Abrechnungen

Introduction

Case Management API

Partner API

paywise Knowledge Center

Start

paywise APIs

Login

Kontakt

Get User

Type of the communication channel to be used. Currently only supports email

* `EMAIL` - E-Mail

Value of the communication channel (e.g. the email Address)

* `STATUS_UPDATE` - Status Updates
* `REQUESTS_TO_CLIENT` - Rückfragen
* `STATEMENTS` - Abrechnungen

tokenAuth

Willkommen im paywise HelpCenter. Hier finden Sie alle Informationen zu paywise und unseren Services

Willkommen

Your first steps with the paywise Partner API

Get Started

The main entities used within the partner API

Entities

API-Only Onboarding

Guide to onboarding users with the Onboarding Web Flow

Web Flow Onboarding

List Companies managed by your account. Provide appropriate filters to limit the search.

List Companies

Create a new company. This is the first step to onboarding a new company company

Create Company

Get Company

Update a Company. Once the Data Submission was completed, cannot be updated anymore

Update Company

List Users managed by your account. Provide appropriate filters to limit the search.

List Users

Create a User. Only available in Instant Onboarding Mode

Create user

Start onboarding of a new user in a company.

Create User Invite

Get a user invite. Used to check on the status of user onbaording

Get User Invite

Use this endpoint to retrieve info on the user after the callback to the success_url.

Get Onboarded User

Get Info about the currently used authentication token and user. Useful for testing your authentication.

Get Token Info

Welcome to the paywise Case Management API

The paywise Case Management API is regularly updated with new and improved features.

Release Notes

List claims

Create a claim

Retrieve a claim

Releases a claim for processing by paywise. To do so, set the claim's *submission_state* field to *released*. After release, a claim cannot be changed anymore. To make changes to an already released claim, please contact our support.

Release claim for processing

Upload a document to a claim. Accepted filetypes are PDF, JPEG and PNG.

Upload a document to a claim

List debtors

Create a debtor

Retrieve a debtor

Add address to a debtor

Add a bank account to an existing debtor.

Add bank account to a debtor

Add a communication channel to an existing debtor.

Add debtor Communication Channel

List mandates

Retrieve a mandate

Set mandate's archived status by modifying it's field **archived**.

Mandates that are archived, are displayed under their own category in the mandates list view in the webinterface.

Changing this property does not affect any business logic on our side. This means, that archiving a running mandate will not stop us from further processing it. Unarchiving on the other hand will not re-activate a closed mandate.

Archive a mandate

List status updates

List payments

Report a payment to a claim that you received from your debtor. Payments can be reported at anytime - **before or after** releasing a claim for processing and at any state of us processing a claim or mandate.

Create a payment

Retrieve a single payment which you reported.

Partner API

Companies

Users

User Invites

Token Info

Get User

Authorizations

Path Parameters

Response