Get mandate

import requests

url = "https://api.paywise.de/v2/mandates/{id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paywise.de/v2/mandates/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/v2/mandates/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "archived": false,
  "claims": [
    {
      "additional_charges": [],
      "additional_charges_amount": {
        "currency": "EUR",
        "value": "0.00"
      },
      "additional_debtor_ids": [],
      "created_at": "2026-07-18T10:00:00Z",
      "debtor_id": "40000000-0000-4000-8000-000000000001",
      "delay_date": "2026-07-09",
      "dispute_reason": null,
      "document_date": "2026-06-05",
      "document_reference": "2026-0042",
      "documents": [],
      "due_date": "2026-06-19",
      "events": [
        {
          "description": null,
          "location": null,
          "occurence": "2026-06-05T09:00:00Z",
          "title": "Invoice issued",
          "type": "claim",
          "your_reference": "2026-0042"
        }
      ],
      "id": "30000000-0000-4000-8000-000000000001",
      "is_disputed": false,
      "items": [],
      "legal_basis": {
        "claim_type_code": null,
        "contract_date": null,
        "description": null
      },
      "mandate_id": "50000000-0000-4000-8000-000000000001",
      "metadata": [
        {
          "type": "comment",
          "value": "Consulting invoice from the customer portal"
        }
      ],
      "order_id": "20000000-0000-4000-8000-000000000001",
      "payments": [],
      "principal_amount": {
        "currency": "EUR",
        "value": "100.00"
      },
      "reminders": [],
      "status": "accepted",
      "subject_matter": "Website accessibility consulting in June 2026",
      "total_amount": {
        "currency": "EUR",
        "value": "100.00"
      },
      "type": "receivable",
      "updated_at": "2026-07-18T10:00:00Z",
      "your_reference": "INV-2026-0042"
    }
  ],
  "created_at": "2026-07-18T11:00:00Z",
  "debtor": {
    "acting_as": "consumer",
    "events": [
      {
        "description": null,
        "location": null,
        "occurence": "2026-05-01T09:00:00Z",
        "title": "Customer registered",
        "type": "registration",
        "your_reference": null
      }
    ],
    "legal_form": null,
    "metadata": [
      {
        "type": "user:reference",
        "value": "CUSTOMER-1001"
      }
    ],
    "organization": null,
    "person": {
      "birth_date": null,
      "first_name": "Alex",
      "last_name": "Example",
      "salutation": "mx"
    },
    "your_reference": "CUSTOMER-1001"
  },
  "id": "50000000-0000-4000-8000-000000000001",
  "legal_balance": null,
  "main_case": null,
  "previous_reference_numbers": [],
  "reference_number": "PW-2026-000123",
  "state": {
    "legal_stage": {
      "code": "extrajudicial",
      "label": "Extrajudicial",
      "label_key": "mandate.state.legal_stage.extrajudicial"
    },
    "payment": {
      "code": "open",
      "label": "Open",
      "label_key": "mandate.state.payment.open"
    },
    "processing": {
      "code": "active",
      "label": "Active",
      "label_key": "mandate.state.processing.active"
    }
  },
  "subcases": [],
  "total_amount": {
    "currency": "EUR",
    "value": "100.00"
  },
  "updated_at": "2026-07-18T11:00:00Z"
}

Mandates

Get mandate

Accepted cases (Aktenzeichen).

Main-case-centric: the list returns main cases only. Sub-cases are reachable through the main case detail representation and direct detail/subresource URLs, not a flat list expansion. Tenant-scoped by the authenticated company.

Sub-resources of one mandate:

payments — the reported, non-ignored payments
documents — claim-document metadata and a proxy-stream download
history — published client activity, related resources, and attachments. A main case includes its subcases; a subcase includes only itself.

The sub-resource operations resolve the mandate including sub-cases — unlike the list, which hides sub-cases — so an individually-addressable sub-case’s own track stays reachable. These public mandate operations are reads.

GET

mandates

{id}

Get mandate

import requests

url = "https://api.paywise.de/v2/mandates/{id}/"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paywise.de/v2/mandates/{id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/v2/mandates/{id}/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "archived": false,
  "claims": [
    {
      "additional_charges": [],
      "additional_charges_amount": {
        "currency": "EUR",
        "value": "0.00"
      },
      "additional_debtor_ids": [],
      "created_at": "2026-07-18T10:00:00Z",
      "debtor_id": "40000000-0000-4000-8000-000000000001",
      "delay_date": "2026-07-09",
      "dispute_reason": null,
      "document_date": "2026-06-05",
      "document_reference": "2026-0042",
      "documents": [],
      "due_date": "2026-06-19",
      "events": [
        {
          "description": null,
          "location": null,
          "occurence": "2026-06-05T09:00:00Z",
          "title": "Invoice issued",
          "type": "claim",
          "your_reference": "2026-0042"
        }
      ],
      "id": "30000000-0000-4000-8000-000000000001",
      "is_disputed": false,
      "items": [],
      "legal_basis": {
        "claim_type_code": null,
        "contract_date": null,
        "description": null
      },
      "mandate_id": "50000000-0000-4000-8000-000000000001",
      "metadata": [
        {
          "type": "comment",
          "value": "Consulting invoice from the customer portal"
        }
      ],
      "order_id": "20000000-0000-4000-8000-000000000001",
      "payments": [],
      "principal_amount": {
        "currency": "EUR",
        "value": "100.00"
      },
      "reminders": [],
      "status": "accepted",
      "subject_matter": "Website accessibility consulting in June 2026",
      "total_amount": {
        "currency": "EUR",
        "value": "100.00"
      },
      "type": "receivable",
      "updated_at": "2026-07-18T10:00:00Z",
      "your_reference": "INV-2026-0042"
    }
  ],
  "created_at": "2026-07-18T11:00:00Z",
  "debtor": {
    "acting_as": "consumer",
    "events": [
      {
        "description": null,
        "location": null,
        "occurence": "2026-05-01T09:00:00Z",
        "title": "Customer registered",
        "type": "registration",
        "your_reference": null
      }
    ],
    "legal_form": null,
    "metadata": [
      {
        "type": "user:reference",
        "value": "CUSTOMER-1001"
      }
    ],
    "organization": null,
    "person": {
      "birth_date": null,
      "first_name": "Alex",
      "last_name": "Example",
      "salutation": "mx"
    },
    "your_reference": "CUSTOMER-1001"
  },
  "id": "50000000-0000-4000-8000-000000000001",
  "legal_balance": null,
  "main_case": null,
  "previous_reference_numbers": [],
  "reference_number": "PW-2026-000123",
  "state": {
    "legal_stage": {
      "code": "extrajudicial",
      "label": "Extrajudicial",
      "label_key": "mandate.state.legal_stage.extrajudicial"
    },
    "payment": {
      "code": "open",
      "label": "Open",
      "label_key": "mandate.state.payment.open"
    },
    "processing": {
      "code": "active",
      "label": "Active",
      "label_key": "mandate.state.processing.active"
    }
  },
  "subcases": [],
  "total_amount": {
    "currency": "EUR",
    "value": "100.00"
  },
  "updated_at": "2026-07-18T11:00:00Z"
}

Authorizations

Authorization

string

header

required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company

string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

If-None-Match

string

Return 304 with an empty body when the current ETag matches one of the supplied validators (or *).

Path Parameters

string<uuid>

required

UUID of the accepted case in this request.

Query Parameters

expand

enum<string>

With history=true, embed the typed related resource body.

Available options:

history.related_resources

history

boolean

Embed up to 100 unified history entries.

Response

Complete representation of one case, including its main case and sub-cases.

archived

boolean

required

read-only

Whether your company archived the case from its active view.

claims

(Receivable claim · object | Titled claim · object)[]

required

read-only

Claims of the main case, shared by the main case and its sub-cases, ordered by creation time.

A receivable claim based on an invoice, rent, or another obligation. Its principal amount, dates, charges, and documents belong to the claim.

Receivable claim
Titled claim

Show child attributes

created_at

string<date-time>

required

read-only

Time at which the accepted case was created.

debtor

object | null

required

Debtor associated with the accepted case.

Show child attributes

string<uuid>

required

read-only

Stable identifier of the accepted case.

legal_balance

object | null

required

Legal claim, payments, and remaining balance by component for the main case, shared with its sub-cases; null when no legal balance is available.

Show child attributes

main_case

object | null

required

Main case when this resource is a sub-case.

Show child attributes

previous_reference_numbers

string[]

required

read-only

Earlier paywise case-file reference numbers of this case. Usually empty: when a case is re-keyed, reference_number shows the new number and the previous one is appended here. The reference_number list filter also matches these exactly.

reference_number

string

required

read-only

paywise case-file reference number.

state

object

required

Current legal, processing, and payment states.

Show child attributes

subcases

object[]

required

read-only

Up to 100 sub-cases grouped under this main case, ordered by sub-case number. Empty when this resource is itself a sub-case.

Show child attributes

total_amount

object | null

required

Current claim total maintained on the main case, shared with its sub-cases. Use the mandate detail legal_balance for the legal claim and remaining balance broken down by component.

Show child attributes

updated_at

string<date-time>

required

read-only

Time at which the accepted case was last updated.

history

object[]

Up to 100 published history entries. Included only when history=true; use the paginated history endpoint for the full timeline.

Show child attributes

Start here

API essentials

Case Management API

Partner API

Mahnservice API

Integrations

Legacy APIs (v1)

Get mandate

Authorizations

Headers

Path Parameters

Query Parameters

Response