Retrieve a claim
import requests
url = "https://api.paywise.de/v1/claims/{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/v1/claims/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.paywise.de/v1/claims/{id}/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v1/claims/{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);
curl --request GET \
--url https://api.paywise.de/v1/claims/{id}/ \
--header 'Authorization: Bearer <token>'{
"href": "<string>",
"submission_state": "created",
"rejection_reason": "<string>",
"rejected_at": "2023-11-07T05:31:56Z",
"rejection_notified_to": [
"[email protected]"
],
"debtor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandate": {
"href": "<string>",
"id": "<string>",
"reference_number": "<string>"
},
"your_reference": "<string>",
"subject_matter": "<string>",
"occurence_date": "2023-12-25",
"document_reference": "<string>",
"document_date": "2023-12-25",
"due_date": "2023-12-25",
"reminder_date": "2023-12-25",
"delay_date": "2023-12-25",
"total_claim_amount": {
"value": "<string>",
"currency": "EUR"
},
"main_claim_amount": {
"value": "<string>",
"currency": "EUR"
},
"starting_approach": "extrajudicial",
"claim_disputed": true,
"obligation_fulfilled": true,
"documents": [
{
"mime_type": "<string>",
"filename": "<string>",
"id": "<string>"
}
],
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"id": "<string>",
"items": [
{
"description": "<string>",
"quantity": 123,
"amount": {
"value": "<string>",
"currency": "EUR"
},
"unit": "<string>"
}
],
"additional_charges_amount": {
"value": "<string>",
"currency": "EUR"
},
"additional_charges": [
{
"type": "reminder_fee",
"your_reference": "<string>",
"subject_matter": "<string>",
"occurence_date": "2023-12-25",
"document_date": "2023-12-25",
"due_date": "2023-12-25",
"amount": {
"value": "<string>",
"currency": "EUR"
},
"id": "<string>",
"metadata": [
{
"type": "comment",
"value": "<string>"
}
],
"events": [
{
"type": "invoice",
"title": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"your_reference": "<string>",
"description": "<string>",
"location": "<string>"
}
]
}
],
"payments": [
{
"href": "<string>",
"amount": {
"value": "<string>",
"currency": "EUR"
},
"value_date": "2023-12-25",
"created": "2023-11-07T05:31:56Z",
"your_reference": "<string>",
"metadata": [
{
"type": "comment",
"value": "<string>"
}
]
}
],
"metadata": [
{
"type": "comment",
"value": "<string>"
}
],
"events": [
{
"type": "claim",
"title": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"your_reference": "<string>",
"description": "<string>",
"location": "<string>"
}
]
}Frozen v1 · Retrieve a claim
Retrieve a single claim.
GET
/
v1
/
claims
/
{id}
/
Retrieve a claim
import requests
url = "https://api.paywise.de/v1/claims/{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/v1/claims/{id}/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.get("https://api.paywise.de/v1/claims/{id}/")
.header("Authorization", "Bearer <token>")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v1/claims/{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);
curl --request GET \
--url https://api.paywise.de/v1/claims/{id}/ \
--header 'Authorization: Bearer <token>'{
"href": "<string>",
"submission_state": "created",
"rejection_reason": "<string>",
"rejected_at": "2023-11-07T05:31:56Z",
"rejection_notified_to": [
"[email protected]"
],
"debtor": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mandate": {
"href": "<string>",
"id": "<string>",
"reference_number": "<string>"
},
"your_reference": "<string>",
"subject_matter": "<string>",
"occurence_date": "2023-12-25",
"document_reference": "<string>",
"document_date": "2023-12-25",
"due_date": "2023-12-25",
"reminder_date": "2023-12-25",
"delay_date": "2023-12-25",
"total_claim_amount": {
"value": "<string>",
"currency": "EUR"
},
"main_claim_amount": {
"value": "<string>",
"currency": "EUR"
},
"starting_approach": "extrajudicial",
"claim_disputed": true,
"obligation_fulfilled": true,
"documents": [
{
"mime_type": "<string>",
"filename": "<string>",
"id": "<string>"
}
],
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z",
"id": "<string>",
"items": [
{
"description": "<string>",
"quantity": 123,
"amount": {
"value": "<string>",
"currency": "EUR"
},
"unit": "<string>"
}
],
"additional_charges_amount": {
"value": "<string>",
"currency": "EUR"
},
"additional_charges": [
{
"type": "reminder_fee",
"your_reference": "<string>",
"subject_matter": "<string>",
"occurence_date": "2023-12-25",
"document_date": "2023-12-25",
"due_date": "2023-12-25",
"amount": {
"value": "<string>",
"currency": "EUR"
},
"id": "<string>",
"metadata": [
{
"type": "comment",
"value": "<string>"
}
],
"events": [
{
"type": "invoice",
"title": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"your_reference": "<string>",
"description": "<string>",
"location": "<string>"
}
]
}
],
"payments": [
{
"href": "<string>",
"amount": {
"value": "<string>",
"currency": "EUR"
},
"value_date": "2023-12-25",
"created": "2023-11-07T05:31:56Z",
"your_reference": "<string>",
"metadata": [
{
"type": "comment",
"value": "<string>"
}
]
}
],
"metadata": [
{
"type": "comment",
"value": "<string>"
}
],
"events": [
{
"type": "claim",
"title": "<string>",
"occurence": "2023-11-07T05:31:56Z",
"your_reference": "<string>",
"description": "<string>",
"location": "<string>"
}
]
}This page documents a frozen v1 API. It receives only critical correctness or
security corrections. For new integrations, use the current API
and follow the linked migration guide.
Autorisierungen
tokenAuthtokenAuth
Antwort
200 - application/json
The current state of the claim submission. Possible values: created (claim saved in the system; does NOT constitute acceptance by paywise), released (released for processing by paywise), under_review (claim is being reviewed by our team), client_response_pending (waiting for your response), accepted (claim accepted and being processed), rejected (claim was rejected), cancelled (claim was cancelled by the client).
created- Createdreleased- Released for processingunder_review- Under reviewclient_response_pending- Pending client responseaccepted- Acceptedrejected- Rejectedcancelled- Cancelled by client
Verfügbare Optionen:
created, released, under_review, client_response_pending, accepted, rejected, cancelled Our starting approach to collect the claim: extrajudicial ("außergerichtlich") or judicial ("gerichtliches Mahnverfahren").
extrajudicial- Zunächst außergerichtlich startenjudicial- Gleich Mahnbescheid beantragenenforcement- Direkt vollstrecken
Verfügbare Optionen:
extrajudicial, judicial, enforcement 