> ## Documentation Index
> Fetch the complete documentation index at: https://docs.paywise.de/llms.txt
> Use this file to discover all available pages before exploring further.

# Use with Postman

> Import the ready-made Postman collection and its production and sandbox environments to explore the Case Management API.

Every operation of the Case Management API is available as a ready-made
Postman collection, generated from the same OpenAPI specification that powers
this reference. Each request ships with the documented example payloads, a
fresh `Idempotency-Key` per send, and saved example responses — including the
typed error envelopes.

## Download

<CardGroup cols={3}>
  <Card title="Collection" icon="box-archive" href="/api-docs/case-management-api/postman/paywise-case-api-v2.postman_collection.json">
    All operations, grouped by resource
  </Card>

  <Card title="Sandbox environment" icon="flask" href="/api-docs/case-management-api/postman/paywise-sandbox.postman_environment.json">
    Targets api-sandbox.paywise.de
  </Card>

  <Card title="Production environment" icon="rocket" href="/api-docs/case-management-api/postman/paywise-production.postman_environment.json">
    Targets api.paywise.de
  </Card>
</CardGroup>

## Import and authenticate

1. In Postman, choose **Import** and drop in the collection file and both
   environment files (or paste their URLs).
2. Select the **paywise sandbox** environment and set its `apiKey` variable to
   a sandbox key (`pw_sbx_…`) created in the developer portal. Postman stores
   it as a secret.
3. Send **info → Get Case credential context** (`GET /v2/info/`). A `200`
   response naming your company confirms the setup.

The collection authenticates once at collection level with
`Authorization: Bearer {{apiKey}}`; every request inherits it. The active
environment supplies `{{baseUrl}}`, so switching between sandbox and
production is a single dropdown change — with separate `apiKey` values per
environment.

<Warning>
  Start in the [sandbox](/api-docs/case-management-api/concepts/sandbox).
  Requests sent with a production key create real collection orders.
</Warning>

## Partner credentials

A Partner key must act for one entitled company on every Case request. Each
request in the collection carries a disabled `X-On-Behalf-Of-Company` header:
enable it and set the company UUID, or add the header once per folder. See
[Calling the Case Management API](/api-docs/partner-api/concepts/calling-the-case-api).

## Idempotency

Mutating requests send `Idempotency-Key: {{$guid}}`, which generates a fresh
key per send. To retry a command safely, replace it with a pinned value and
resend the identical body — the API then replays the original response
instead of executing twice. See
[Errors and safe retries](/api-docs/essentials/errors-and-safe-retries) for the idempotency contract.

## Staying current

The collection is regenerated from the published OpenAPI specification with
every contract change and carries the specification checksum it was built
from. Re-import after a release announced in the
[changelog](/api-docs/changelog) to pick up new operations. You can also
import the [OpenAPI specification](/api-docs/case-management-api/introduction#download-the-openapi-contract)
into Postman directly — the ready-made collection differs only in the
pre-wired authentication, environments, and idempotency handling.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.