Withdraw order

Withdraw order

import requests

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

payload = { "reason": "The customer paid before review began." }
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({reason: 'The customer paid before review began.'})
};

fetch('https://api.paywise.de/v2/orders/{id}/withdraw/', 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/{id}/withdraw/")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"The customer paid before review began.\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/v2/orders/{id}/withdraw/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Idempotency-Key", "<idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"reason\": \"The customer paid before review began.\"\n}", false);
var response = await client.PostAsync(request);

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

curl --request POST \
  --url https://api.paywise.de/v2/orders/{id}/withdraw/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "reason": "The customer paid before review began."
}
'

{
  "additional_debtors": [
    {
      "acting_as": "consumer",
      "events": [
        {
          "description": "<string>",
          "location": "<string>",
          "occurence": "2023-11-07T05:31:56Z",
          "title": "<string>",
          "type": "<string>",
          "your_reference": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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>"
    }
  ],
  "claims": [
    {
      "additional_charges": [
        {
          "amount": {
            "currency": "EUR",
            "value": "<string>"
          },
          "events": [
            {
              "description": "<string>",
              "location": "<string>",
              "occurence": "2023-11-07T05:31:56Z",
              "title": "<string>",
              "type": "<string>",
              "your_reference": "<string>"
            }
          ],
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "metadata": [
            {
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "occurrence_date": "2023-12-25",
          "subject_matter": "<string>",
          "type": "reminder_fee",
          "your_reference": "<string>"
        }
      ],
      "additional_charges_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "additional_debtor_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "delay_date": "2023-12-25",
      "dispute_reason": "<string>",
      "document_date": "2023-12-25",
      "document_reference": "<string>",
      "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"
        }
      ],
      "due_date": "2023-12-25",
      "events": [
        {
          "description": "<string>",
          "location": "<string>",
          "occurence": "2023-11-07T05:31:56Z",
          "title": "<string>",
          "type": "<string>",
          "your_reference": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_disputed": true,
      "items": [
        {
          "amount": {
            "currency": "EUR",
            "value": "<string>"
          },
          "description": "<string>",
          "quantity": "<string>",
          "unit": "<string>",
          "unit_price": {
            "currency": "EUR",
            "value": "<string>"
          }
        }
      ],
      "legal_basis": {
        "claim_type_code": "<string>",
        "contract_date": "2023-12-25",
        "description": "<string>"
      },
      "mandate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payments": [
        {
          "amount": {
            "currency": "<string>",
            "value": "<string>"
          },
          "claim": {
            "document_reference": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "your_reference": "<string>"
          },
          "created_at": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "mandate": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "reference_number": "<string>"
          },
          "metadata": [
            {
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "updated_at": "2023-11-07T05:31:56Z",
          "value_date": "2023-12-25",
          "your_reference": "<string>"
        }
      ],
      "principal_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "reminders": [
        {
          "date": "2023-12-25",
          "due_date": "2023-12-25",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "status": "draft",
      "subject_matter": "<string>",
      "total_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "type": "receivable",
      "updated_at": "2023-11-07T05:31:56Z",
      "your_reference": "<string>"
    }
  ],
  "confirmation_email": "[email protected]",
  "created_at": "2023-11-07T05:31:56Z",
  "creditor_obligation_fulfilled": true,
  "debtor": {
    "acting_as": "consumer",
    "events": [
      {
        "description": "<string>",
        "location": "<string>",
        "occurence": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "type": "<string>",
        "your_reference": "<string>"
      }
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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>"
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mandate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merged_into": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejection": {
    "code": "<string>",
    "notified_to": [
      "[email protected]"
    ],
    "reason": "<string>",
    "rejected_at": "2023-11-07T05:31:56Z"
  },
  "starting_approach": "extrajudicial",
  "status": "draft",
  "totals": {
    "charges": {
      "currency": "EUR",
      "value": "<string>"
    },
    "main_claims": {
      "currency": "EUR",
      "value": "<string>"
    },
    "order_value": {
      "currency": "EUR",
      "value": "<string>"
    },
    "payments": {
      "currency": "EUR",
      "value": "<string>"
    }
  },
  "type": "invoice",
  "updated_at": "2023-11-07T05:31:56Z"
}

POST

orders

{id}

withdraw

Withdraw order

import requests

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

payload = { "reason": "The customer paid before review began." }
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({reason: 'The customer paid before review began.'})
};

fetch('https://api.paywise.de/v2/orders/{id}/withdraw/', 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/{id}/withdraw/")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"The customer paid before review began.\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.paywise.de/v2/orders/{id}/withdraw/");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Idempotency-Key", "<idempotency-key>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"reason\": \"The customer paid before review began.\"\n}", false);
var response = await client.PostAsync(request);

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

curl --request POST \
  --url https://api.paywise.de/v2/orders/{id}/withdraw/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "reason": "The customer paid before review began."
}
'

{
  "additional_debtors": [
    {
      "acting_as": "consumer",
      "events": [
        {
          "description": "<string>",
          "location": "<string>",
          "occurence": "2023-11-07T05:31:56Z",
          "title": "<string>",
          "type": "<string>",
          "your_reference": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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>"
    }
  ],
  "claims": [
    {
      "additional_charges": [
        {
          "amount": {
            "currency": "EUR",
            "value": "<string>"
          },
          "events": [
            {
              "description": "<string>",
              "location": "<string>",
              "occurence": "2023-11-07T05:31:56Z",
              "title": "<string>",
              "type": "<string>",
              "your_reference": "<string>"
            }
          ],
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "metadata": [
            {
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "occurrence_date": "2023-12-25",
          "subject_matter": "<string>",
          "type": "reminder_fee",
          "your_reference": "<string>"
        }
      ],
      "additional_charges_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "additional_debtor_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "created_at": "2023-11-07T05:31:56Z",
      "debtor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "delay_date": "2023-12-25",
      "dispute_reason": "<string>",
      "document_date": "2023-12-25",
      "document_reference": "<string>",
      "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"
        }
      ],
      "due_date": "2023-12-25",
      "events": [
        {
          "description": "<string>",
          "location": "<string>",
          "occurence": "2023-11-07T05:31:56Z",
          "title": "<string>",
          "type": "<string>",
          "your_reference": "<string>"
        }
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_disputed": true,
      "items": [
        {
          "amount": {
            "currency": "EUR",
            "value": "<string>"
          },
          "description": "<string>",
          "quantity": "<string>",
          "unit": "<string>",
          "unit_price": {
            "currency": "EUR",
            "value": "<string>"
          }
        }
      ],
      "legal_basis": {
        "claim_type_code": "<string>",
        "contract_date": "2023-12-25",
        "description": "<string>"
      },
      "mandate_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "payments": [
        {
          "amount": {
            "currency": "<string>",
            "value": "<string>"
          },
          "claim": {
            "document_reference": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "your_reference": "<string>"
          },
          "created_at": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "mandate": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "reference_number": "<string>"
          },
          "metadata": [
            {
              "type": "<string>",
              "value": "<string>"
            }
          ],
          "updated_at": "2023-11-07T05:31:56Z",
          "value_date": "2023-12-25",
          "your_reference": "<string>"
        }
      ],
      "principal_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "reminders": [
        {
          "date": "2023-12-25",
          "due_date": "2023-12-25",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "status": "draft",
      "subject_matter": "<string>",
      "total_amount": {
        "currency": "EUR",
        "value": "<string>"
      },
      "type": "receivable",
      "updated_at": "2023-11-07T05:31:56Z",
      "your_reference": "<string>"
    }
  ],
  "confirmation_email": "[email protected]",
  "created_at": "2023-11-07T05:31:56Z",
  "creditor_obligation_fulfilled": true,
  "debtor": {
    "acting_as": "consumer",
    "events": [
      {
        "description": "<string>",
        "location": "<string>",
        "occurence": "2023-11-07T05:31:56Z",
        "title": "<string>",
        "type": "<string>",
        "your_reference": "<string>"
      }
    ],
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "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>"
  },
  "expires_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mandate": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "merged_into": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejection": {
    "code": "<string>",
    "notified_to": [
      "[email protected]"
    ],
    "reason": "<string>",
    "rejected_at": "2023-11-07T05:31:56Z"
  },
  "starting_approach": "extrajudicial",
  "status": "draft",
  "totals": {
    "charges": {
      "currency": "EUR",
      "value": "<string>"
    },
    "main_claims": {
      "currency": "EUR",
      "value": "<string>"
    },
    "order_value": {
      "currency": "EUR",
      "value": "<string>"
    },
    "payments": {
      "currency": "EUR",
      "value": "<string>"
    }
  },
  "type": "invoice",
  "updated_at": "2023-11-07T05:31:56Z"
}

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.

Idempotency-Key

string

required

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: 255

Path Parameters

string<uuid>

required

UUID of the order in this request.

Body

application/json

Optional plain-text reason for a client-initiated withdrawal.

reason

string | null

Optional explanation for withdrawing an eligible submitted order before acceptance or active review prevents withdrawal. Maximum 5000 characters.

Maximum string length: 5000

Response

Invoice order
Rental order
Titled order

An invoice order contains receivable claims and exposes starting_approach and creditor_obligation_fulfilled.

Read representation of an order.

status is derived from the order's submission and review progress; mandate names the created mandate once the order is accepted; merged_into names the surviving order when this order was merged away during review.

additional_debtors

object[]

required

read-only

Inline summaries of the additional debtors. Retrieve each debtor's full details with GET /v2/debtors/{id}/ using its id. Replace membership through PATCH /v2/orders/{id}/ while the order is a draft. API submissions are limited to 10 additional debtors.

Show child attributes

claims

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

required

read-only

Receivable claims belonging to this order, including their itemized charges and documents. Titled claims are accepted only in titled orders. API submissions are limited to 50 claims per order.

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

confirmation_email

string<email> | null

required

read-only

Address receiving the order-entry confirmation, when requested.

created_at

string<date-time>

required

read-only

Time at which the order was created.

creditor_obligation_fulfilled

boolean | null

required

read-only

Whether you fully performed your obligation to the debtor.

debtor

object

required

Inline summary of the primary debtor. Retrieve full details with GET /v2/debtors/{id}/ using its id.

Show child attributes

expires_at

string<date-time> | null

required

read-only

Time at which this API-created draft expires: updated_at plus 90 days, refreshed by every successful draft change. Once it has passed, the order reads expired and every change answers 409 order_expired until the daily cleanup deletes it. Null once the order is finalized and for orders created in the portal.

string<uuid>

required

read-only

Stable identifier of this order.

mandate

string<uuid> | null

required

read-only

Accepted case created from this order, when available.

merged_into

string<uuid> | null

required

read-only

Surviving order when this order was merged during review.

rejection

object | null

required

Why paywise declined the order: reason, time, notified recipients, and the standard reason's key. Null unless status is rejected.

Show child attributes

starting_approach

enum<string> | null

required

Initial collection route: extrajudicial starts out of court; judicial starts by applying for a payment order (Mahnbescheid). Null while this decision is unset.

Available options:

extrajudicial,

judicial

status

enum<string>

required

Order lifecycle state: draft is editable; submitted awaits processing; awaiting_client_response requires client input; accepted has entered case processing; rejected was declined; withdrawn was cancelled by the client; expired passed its draft deadline and accepts no further changes (409 order_expired) until the daily cleanup deletes it; merged points to the surviving order in merged_into.

Available options:

draft,

submitted,

awaiting_client_response,

accepted,

rejected,

withdrawn,

expired,

merged

totals

object

required

Financial totals calculated across the order's claims.

Show child attributes

type

enum<string>

required

Literal invoice order discriminator.

Available options:

invoice

updated_at

string<date-time>

required

read-only

Time at which the order was last updated.

Start here

API essentials

Case Management API

Partner API

Mahnservice API

Integrations

Legacy APIs (v1)

Authorizations

Headers

Path Parameters

Body

Response