The SDKs are in beta (version
0.x). Until 1.0.0, a minor version may contain breaking changes; pin the version you test against.Install
Create a client
Create an API key in the paywise portal under Für Entwickler, see Authentication and environments. Choose the environment that matches the key: sandbox keys start withpw_sbx_ and only work against the sandbox.
caseManagement (Python: case_management), Partner operations under partner. A key can only call the operations its type and permission scopes allow.
Partner keys: act on behalf of a company
A Partner key calls the Case Management API for one of its managed companies by sending theX-On-Behalf-Of-Company header. Set it on the client; use one client per company. Direct Case Management keys must not send this header.
Pagination
List operations return a pager that follows thenext link of each page, see Pagination and synchronization.
Errors, retries and idempotency
Non-2xx responses raise a typed error per status code, for exampleUnauthorizedError for 401. All errors expose the status code and the parsed error body.
The SDKs retry 408, 429 and 5xx responses twice by default and honour Retry-After; the Python SDK also retries 409. Change the limit with maxRetries (Python: max_retries) on the client or per request.
Operations that create something take the Idempotency-Key as a required parameter. Retries reuse the same key, so a repeated request returns the original result instead of creating a second record. Generate one key per logical operation and keep it when you retry yourself.
Versions and support
The SDKs are generated from the published OpenAPI contracts on this site and follow them closely. New API fields and operations reach the SDKs in a new release; see the release notes in each repository. Report problems with the SDKs at [email protected] or as an issue in paywise-gmbh/developer-resources. The full list of methods is in thereference.md of each SDK repository.