import requests
url = "https://api.paywise.de/v2/mandates/"
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/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.paywise.de/v2/mandates/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/mandates/");
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);
curl --request GET \
--url https://api.paywise.de/v2/mandates/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"results": [
{
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"debtor": {
"acting_as": "consumer",
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"legal_form": "<string>",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"organization": {
"commercial_register": "<string>",
"commercial_registration_number": "<string>",
"name": "<string>"
},
"person": {
"birth_date": "2023-12-25",
"first_name": "<string>",
"last_name": "<string>",
"salutation": "mr"
},
"your_reference": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previous_reference_numbers": [
"<string>"
],
"reference_number": "<string>",
"state": {
"legal_stage": {
"code": "<string>",
"label": "<string>",
"label_key": "<string>"
},
"payment": {
"code": "<string>",
"label": "<string>",
"label_key": "<string>"
},
"processing": {
"code": "<string>",
"label": "<string>",
"label_key": "<string>"
}
},
"total_amount": {
"currency": "<string>",
"value": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100"
}{
"code": "validation_error",
"detail": "The request contains invalid data.",
"errors": [
{
"code": "invalid",
"field": "claims[0].due_date",
"message": "Due date must not precede the document date."
}
]
}{
"code": "not_authenticated",
"detail": "Authentication credentials were not provided."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}List mandates
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.
import requests
url = "https://api.paywise.de/v2/mandates/"
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/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.paywise.de/v2/mandates/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/mandates/");
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);
curl --request GET \
--url https://api.paywise.de/v2/mandates/ \
--header 'Authorization: Bearer <token>'{
"count": 123,
"results": [
{
"archived": true,
"created_at": "2023-11-07T05:31:56Z",
"debtor": {
"acting_as": "consumer",
"events": [
{
"description": "<string>",
"location": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"title": "<string>",
"type": "<string>",
"your_reference": "<string>"
}
],
"legal_form": "<string>",
"metadata": [
{
"type": "<string>",
"value": "<string>"
}
],
"organization": {
"commercial_register": "<string>",
"commercial_registration_number": "<string>",
"name": "<string>"
},
"person": {
"birth_date": "2023-12-25",
"first_name": "<string>",
"last_name": "<string>",
"salutation": "mr"
},
"your_reference": "<string>"
},
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"previous_reference_numbers": [
"<string>"
],
"reference_number": "<string>",
"state": {
"legal_stage": {
"code": "<string>",
"label": "<string>",
"label_key": "<string>"
},
"payment": {
"code": "<string>",
"label": "<string>",
"label_key": "<string>"
},
"processing": {
"code": "<string>",
"label": "<string>",
"label_key": "<string>"
}
},
"total_amount": {
"currency": "<string>",
"value": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z"
}
],
"next": "http://api.example.org/accounts/?offset=400&limit=100",
"previous": "http://api.example.org/accounts/?offset=200&limit=100"
}{
"code": "validation_error",
"detail": "The request contains invalid data.",
"errors": [
{
"code": "invalid",
"field": "claims[0].due_date",
"message": "Due date must not precede the document date."
}
]
}{
"code": "not_authenticated",
"detail": "Authentication credentials were not provided."
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}{
"code": "<string>",
"detail": "<string>",
"errors": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Company-bound Case Management API key — the standard credential for this API.
Headers
Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.
Query Parameters
Whether the accepted case is archived. When omitted, archived cases are hidden unless updated_since is set; with updated_since archived and active cases are both returned.
Created at or after this timestamp (inclusive).
Created at or before this timestamp (inclusive).
Exact legal stage of the accepted case.
Number of results to return (maximum 100).
1 <= x <= 100Zero-based result offset.
x >= 0Comma-separated sort fields: debtor name, created, total claim amount, or the latest published status title (status). Prefix a field with - for descending order. Defaults to -created; updated_since uses its synchronization order instead.
Payment state: unpaid, partially_paid, or fully_paid. Repeat the parameter to include any of several states.
fully_paid, partially_paid, unpaid Exact processing state. Repeat the parameter to include any of several states.
canceled_by_client, canceled_by_service_provider, ended, in_progress, paused A UUID matches the case, one of its subcases, or one of its claims. Otherwise searches case-insensitively by substring: debtor names (accents ignored), your debtor reference, current and previous case references, claim and document references, and, from three characters, the titles, texts and event codes of published status updates. Subcase matches return their main case. Debtor name and reference matches include production-mode debtors only, as in the portal.
Case-insensitive substring of the current paywise case reference, or an exact match on a previous paywise reference.
Filter by published open or answered client requests, or by having no published client requests. Repeat the parameter to include any of these categories.
has_answered_requests_to_client, has_no_requests_to_client, has_open_requests_to_client Return rows changed at or after this timezone-aware RFC 3339 timestamp. Results are ordered by updated_at and id.
Response
Total number of matching resources.
123
Resources returned for the requested page.
Show child attributes
Show child attributes
URL for the next page, or null when this is the last page.
"http://api.example.org/accounts/?offset=400&limit=100"
URL for the previous page, or null when this is the first page.
"http://api.example.org/accounts/?offset=200&limit=100"
