import requests
url = "https://api.paywise.de/v2/orders/{order_id}/messages/"
payload = {
"body": "The customer provided an updated invoice address.",
"title": "Updated invoice address"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
body: JSON.stringify('The customer provided an updated invoice address.'),
title: 'Updated invoice address'
})
};
fetch('https://api.paywise.de/v2/orders/{order_id}/messages/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.paywise.de/v2/orders/{order_id}/messages/")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"The customer provided an updated invoice address.\",\n \"title\": \"Updated invoice address\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/orders/{order_id}/messages/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Idempotency-Key", "<idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"body\": \"The customer provided an updated invoice address.\",\n \"title\": \"Updated invoice address\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request POST \
--url https://api.paywise.de/v2/orders/{order_id}/messages/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"body": "The customer provided an updated invoice address.",
"title": "Updated invoice address"
}
'{
"author": {
"type": "api"
},
"body": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"documents": [
{
"created_at": "2023-11-07T05:31:56Z",
"download_url": "<string>",
"failure_reason": "page_limit_exceeded",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mime_type": "<string>",
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "claim"
},
"status": "pending",
"type": "bank_statement",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"editable": true,
"href": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "order"
},
"response_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sender": "client",
"state": "under_review",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}Create order message
Messages exchanged with paywise about one order or one case.
import requests
url = "https://api.paywise.de/v2/orders/{order_id}/messages/"
payload = {
"body": "The customer provided an updated invoice address.",
"title": "Updated invoice address"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
body: JSON.stringify('The customer provided an updated invoice address.'),
title: 'Updated invoice address'
})
};
fetch('https://api.paywise.de/v2/orders/{order_id}/messages/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));HttpResponse<String> response = Unirest.post("https://api.paywise.de/v2/orders/{order_id}/messages/")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"The customer provided an updated invoice address.\",\n \"title\": \"Updated invoice address\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/orders/{order_id}/messages/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Idempotency-Key", "<idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"body\": \"The customer provided an updated invoice address.\",\n \"title\": \"Updated invoice address\"\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
curl --request POST \
--url https://api.paywise.de/v2/orders/{order_id}/messages/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"body": "The customer provided an updated invoice address.",
"title": "Updated invoice address"
}
'{
"author": {
"type": "api"
},
"body": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"documents": [
{
"created_at": "2023-11-07T05:31:56Z",
"download_url": "<string>",
"failure_reason": "page_limit_exceeded",
"filename": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mime_type": "<string>",
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "claim"
},
"status": "pending",
"type": "bank_statement",
"updated_at": "2023-11-07T05:31:56Z"
}
],
"editable": true,
"href": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"parent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "order"
},
"response_to": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sender": "client",
"state": "under_review",
"title": "<string>",
"updated_at": "2023-11-07T05:31:56Z"
}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.
Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.
255Path Parameters
UUID of the parent order in this request.
Body
Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.
Message content sent to paywise; supported HTML is sanitized and the content must not be empty after sanitization.
1 - 262144Short subject of the message.
1 - 200Documents attached to the message. At most 20 documents and 50 MiB of decoded document content per command. Each file is limited to 10 MiB and each PDF to 100 pages. Exceeding a limit rejects the command with 400.
20Show child attributes
Show child attributes
Response
Resource representation with a native UUID id.
Channel through which the message was authored.
Show child attributes
Show child attributes
Message content exchanged with paywise.
Time at which the message was created.
Documents attached to the message.
Show child attributes
Show child attributes
Whether this message can be edited through the API. True only for a client message created through current Case Management API for the calling company while it is under review and no review task has started.
API URL of this message.
Stable identifier for this resource.
Order or accepted case to which the message belongs.
Show child attributes
Show child attributes
Message to which this message responds, when applicable.
Party that sent the message.
client, paywise Review/publication state: under_review for a client message awaiting review, handled after handling, or published for a published message. Check editable before offering edits.
under_review, handled, published Short subject of the message.
Time at which the message was last updated.
