Create order message document
import requests
url = "https://api.paywise.de/v2/orders/{order_id}/messages/{message_id}/documents/"
payload = { "type": "invoice" }
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({type: 'invoice'})
};
fetch('https://api.paywise.de/v2/orders/{order_id}/messages/{message_id}/documents/', 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/{message_id}/documents/")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"invoice\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/orders/{order_id}/messages/{message_id}/documents/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Idempotency-Key", "<idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"type\": \"invoice\"\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/{message_id}/documents/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"type": "invoice"
}
'{
"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"
}Messages
Create order message document
Documents below one parent resource: upload, list, download, delete.
POST
/
v2
/
orders
/
{order_id}
/
messages
/
{message_id}
/
documents
/
Create order message document
import requests
url = "https://api.paywise.de/v2/orders/{order_id}/messages/{message_id}/documents/"
payload = { "type": "invoice" }
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({type: 'invoice'})
};
fetch('https://api.paywise.de/v2/orders/{order_id}/messages/{message_id}/documents/', 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/{message_id}/documents/")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"invoice\"\n}")
.asString();using RestSharp;
var options = new RestClientOptions("https://api.paywise.de/v2/orders/{order_id}/messages/{message_id}/documents/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Idempotency-Key", "<idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"type\": \"invoice\"\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/{message_id}/documents/ \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"type": "invoice"
}
'{
"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"
}Authorizations
caseBearerAuthpartnerBearerAuth
Headers
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.
Maximum string length:
255Path Parameters
Body
application/jsonmultipart/form-data
Document upload; the parent resource comes from the URL.
Business purpose of the document.
bank_statement- bank_statementclaim_statement- claim_statementcorrespondence- correspondenceenforceable_title- enforceable_titleinvoice- invoiceother- otherpayment_proof- payment_proofreminder- reminderrental_agreement- rental_agreement
Available options:
bank_statement, claim_statement, correspondence, enforceable_title, invoice, other, payment_proof, reminder, rental_agreement Response
Resource representation with a native UUID id.
Why processing failed when status is failed; null otherwise. page_limit_exceeded: PDF above the 100-page ceiling; encrypted: password-protected PDF; corrupt: bytes could not be parsed; unsupported: content type not accepted; processing_failed: any other processing error.
Available options:
page_limit_exceeded, encrypted, corrupt, unsupported, processing_failed 