Skip to main content
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

Collection

All operations, grouped by resource

Sandbox environment

Targets api-sandbox.paywise.de

Production environment

Targets api.paywise.de

​
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.
Start in the sandbox. Requests sent with a production key create real collection orders.

​
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.

​
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 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 to pick up new operations. You can also import the OpenAPI specification into Postman directly — the ready-made collection differs only in the pre-wired authentication, environments, and idempotency handling.