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

# Get mandate correspondence item

> Debtor correspondence of one accepted case, read-only.



## OpenAPI

````yaml /api-docs/case-management-api/openapi.json get /v2/mandates/{mandate_id}/correspondence/{id}/
openapi: 3.0.3
info:
  description: >-
    Submit orders and manage their complete lifecycle through the current API at
    the `/v2/` HTTP path.
  title: paywise Case Management API
  version: current
servers:
  - description: Production environment
    url: https://api.paywise.de
  - description: Sandbox environment
    url: https://api-sandbox.paywise.de
security: []
tags:
  - description: Submit orders and manage them until acceptance.
    name: Orders
  - description: Stable claim resources and their current relationships.
    name: Claims
  - description: 'Accepted cases: state, published history and documents.'
    name: Mandates
  - description: Debtor master data reused across orders.
    name: Debtors
  - description: Payments reported by you and booked by paywise.
    name: Payments
  - description: Files attached to claims and other resources.
    name: Documents
  - description: Collective statements (Sammelabrechnungen).
    name: Statements
  - description: Per-case statements (Aktenabrechnungen).
    name: Single mandate statements
  - description: Webhook endpoints and their signing secrets.
    name: Webhooks
  - description: Delivery log and redelivery of webhook events.
    name: Webhook deliveries
  - description: Ordered feed of the events webhooks deliver.
    name: Events
  - description: Reference catalog of legal forms.
    name: Legal forms
  - description: The authenticated credential and its context.
    name: Info
  - description: Rate-limit headroom of the credential.
    name: Usage
  - description: Availability of the API.
    name: Health
externalDocs:
  url: https://docs.paywise.de/api-docs/case-management-api/introduction
paths:
  /v2/mandates/{mandate_id}/correspondence/{id}/:
    get:
      tags:
        - Mandates
      summary: Get mandate correspondence item
      description: Debtor correspondence of one accepted case, read-only.
      operationId: get-mandate-correspondence-item
      parameters:
        - description: >-
            Required when a Partner key calls the Case Management API; rejected
            for direct Case keys. Contains the entitled paywise company UUID.
          in: header
          name: X-On-Behalf-Of-Company
          schema:
            format: uuid
            type: string
        - description: UUID of the correspondence item in this request.
          in: path
          name: id
          required: true
          schema:
            format: uuid
            type: string
        - description: UUID of the parent accepted case in this request.
          in: path
          name: mandate_id
          required: true
          schema:
            format: uuid
            type: string
        - description: >-
            Return 304 with an empty body when the current `ETag` matches one of
            the supplied validators (or `*`).
          in: header
          name: If-None-Match
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              examples:
                correspondence-detail:
                  value:
                    attachments:
                      - download_url: >-
                          https://api-sandbox.paywise.de/v2/mandates/50000000-0000-4000-8000-000000000001/correspondence/f3000000-0000-4000-8000-000000000001/attachments/logical_0123456789abcdef01234567/download/
                        filename: kontoauszug.pdf
                        id: logical_0123456789abcdef01234567
                        mime_type: application/pdf
                        size_bytes: 48213
                        status: available
                    body:
                      complete: true
                      quoted_text: null
                      text: Guten Tag, ich möchte in Raten zahlen.
                    channel: email
                    direction: inbound
                    email:
                      cc: []
                      from: debtor@example.test
                      to:
                        - inkasso@paywise.de
                    history_entry_ids:
                      - f0000000-0000-4000-8000-000000000001
                    id: f3000000-0000-4000-8000-000000000001
                    occurred_at: '2026-08-27T10:58:00Z'
                    pdf_url: >-
                      https://api-sandbox.paywise.de/v2/mandates/50000000-0000-4000-8000-000000000001/correspondence/f3000000-0000-4000-8000-000000000001/pdf/
                    source_mandate:
                      id: 50000000-0000-4000-8000-000000000001
                      reference_number: PW-2026-000042
                      relation: main_case
                    subject: Ratenzahlung
                    updated_at: '2026-08-27T11:05:00Z'
                    url: >-
                      https://api-sandbox.paywise.de/v2/mandates/50000000-0000-4000-8000-000000000001/correspondence/f3000000-0000-4000-8000-000000000001/
              schema:
                $ref: '#/components/schemas/CorrespondenceDetail'
          description: ''
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            ETag:
              description: >-
                Strong validator of this representation. Send it back as
                `If-None-Match` to skip an unchanged re-read (304) or as
                `If-Match` on PATCH/PUT/DELETE to fail with 412 when the
                resource changed.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '304':
          description: 'Not modified: the `If-None-Match` validator still matches.'
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '401':
          content:
            application/json:
              examples:
                authentication-error:
                  value:
                    code: not_authenticated
                    detail: Authentication credentials were not provided.
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '404':
          content:
            application/json:
              examples:
                not-found-error:
                  value:
                    code: not_found
                    detail: The requested resource was not found.
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            Retry-After:
              description: Integer seconds to wait before retrying a throttled request.
              schema:
                minimum: 1
                type: integer
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Standard error response.
          headers:
            Cache-Control:
              description: >-
                Cacheability directive. Authenticated responses use `private,
                no-store`; the legal-form catalog may use `private,
                max-age=86400`.
              schema:
                type: string
            X-Paywise-Environment:
              description: Environment that produced the response.
              schema:
                enum:
                  - production
                  - sandbox
                type: string
            X-Paywise-Request-Id:
              description: >-
                Fresh server-assigned correlation id for this response.
                Caller-provided request ids are ignored.
              schema:
                format: uuid
                type: string
      security:
        - caseBearerAuth: []
        - partnerBearerAuth: []
components:
  schemas:
    CorrespondenceDetail:
      description: List row plus the projected text and the attachment inventory.
      properties:
        attachments:
          description: Attachments of the message that a creditor may download.
          items:
            $ref: '#/components/schemas/CorrespondenceAttachment'
          readOnly: true
          type: array
        body:
          allOf:
            - $ref: '#/components/schemas/CorrespondenceBody'
          description: Projected plain text, or null when no body is stored.
          nullable: true
          readOnly: true
        channel:
          description: >-
            Communication channel. Open enumeration: `email` today; clients must
            tolerate new values.
          readOnly: true
          type: string
        direction:
          allOf:
            - $ref: '#/components/schemas/DirectionEnum'
          description: Whether paywise received or sent the message.
          readOnly: true
        email:
          allOf:
            - $ref: '#/components/schemas/CorrespondenceEmailDetails'
          description: Email-channel details; present when `channel` is `email`.
          readOnly: true
        history_entry_ids:
          description: >-
            Published history entries that surface this message; empty for
            messages reachable only through a client request.
          items:
            format: uuid
            type: string
          readOnly: true
          type: array
        id:
          description: Stable identifier of the correspondence item.
          format: uuid
          readOnly: true
          type: string
        occurred_at:
          description: Time the message was received or sent.
          format: date-time
          readOnly: true
          type: string
        pdf_url:
          description: >-
            Authenticated URL of the message rendered as PDF (header block and
            plain text).
          format: uri
          readOnly: true
          type: string
        source_mandate:
          allOf:
            - $ref: '#/components/schemas/HistorySourceMandate'
          description: Main case or subcase the message belongs to.
          readOnly: true
        subject:
          description: Subject line, or null.
          nullable: true
          readOnly: true
          type: string
        updated_at:
          description: Latest change to this item; use for incremental synchronization.
          format: date-time
          readOnly: true
          type: string
        url:
          description: Authenticated API URL of this item.
          format: uri
          readOnly: true
          type: string
      required:
        - attachments
        - body
        - channel
        - direction
        - email
        - history_entry_ids
        - id
        - occurred_at
        - pdf_url
        - source_mandate
        - subject
        - updated_at
        - url
      type: object
    Error:
      properties:
        code:
          description: Machine-readable error category.
          type: string
        detail:
          description: Short human-readable summary of the error.
          type: string
        errors:
          description: Field-level validation errors, when applicable.
          items:
            $ref: '#/components/schemas/ErrorItem'
          type: array
      required:
        - detail
        - code
      type: object
    CorrespondenceAttachment:
      properties:
        download_url:
          description: Authenticated download URL, or null when `status` is `unavailable`.
          format: uri
          nullable: true
          readOnly: true
          type: string
        filename:
          description: Filename as it arrived; sanitised at download time.
          readOnly: true
          type: string
        id:
          description: >-
            Opaque, stable identifier of the attachment within this
            correspondence item.
          maxLength: 255
          readOnly: true
          type: string
        mime_type:
          description: >-
            Declared media type; the download sniffs the bytes and may answer
            with a different `Content-Type`.
          readOnly: true
          type: string
        size_bytes:
          description: Size in bytes, or null when the mail does not declare it.
          nullable: true
          readOnly: true
          type: integer
        status:
          description: >-
            `available` when the bytes can be downloaded; `unavailable` when the
            mail structure does not allow it. Open enumeration: clients must
            tolerate new values.
          readOnly: true
          type: string
      required:
        - download_url
        - filename
        - id
        - mime_type
        - size_bytes
        - status
      type: object
    CorrespondenceBody:
      properties:
        complete:
          description: >-
            False when the text was cut at the size limit or the stored mail
            could only be projected partially.
          readOnly: true
          type: boolean
        quoted_text:
          description: Quoted earlier messages below the new part, or null.
          nullable: true
          readOnly: true
          type: string
        text:
          description: >-
            Visible text of the new message part, projected from the stored
            mail; never HTML.
          readOnly: true
          type: string
      required:
        - complete
        - quoted_text
        - text
      type: object
    DirectionEnum:
      enum:
        - inbound
        - outbound
      type: string
    CorrespondenceEmailDetails:
      properties:
        cc:
          description: Carbon-copy addresses.
          items:
            type: string
          type: array
        from:
          description: Sender address.
          nullable: true
          type: string
        to:
          description: Recipient addresses.
          items:
            type: string
          type: array
      required:
        - cc
        - from
        - to
      type: object
    HistorySourceMandate:
      properties:
        id:
          description: Identifier of the case that produced the entry.
          format: uuid
          readOnly: true
          type: string
        reference_number:
          description: paywise reference number of the source case.
          readOnly: true
          type: string
        relation:
          allOf:
            - $ref: '#/components/schemas/RelationEnum'
          description: |-
            Main-case or subcase attribution.

            * `main_case` - main_case
            * `subcase` - subcase
          readOnly: true
      required:
        - id
        - reference_number
        - relation
      type: object
    ErrorItem:
      properties:
        code:
          description: Machine-readable field error code.
          type: string
        field:
          description: >-
            Path to the field that caused the error, using dots for objects and
            brackets for list indexes, for example `claims[0].amount`; null for
            an error without a field path.
          nullable: true
          type: string
        message:
          description: Human-readable explanation of the field error.
          type: string
      required:
        - field
        - code
        - message
      type: object
    RelationEnum:
      description: |-
        * `main_case` - main_case
        * `subcase` - subcase
      enum:
        - main_case
        - subcase
      type: string
  securitySchemes:
    caseBearerAuth:
      description: >-
        Company-bound Case Management API key — the standard credential for this
        API.
      scheme: bearer
      type: http
    partnerBearerAuth:
      description: >-
        Partner API key acting for one entitled company; every Case request must
        then also carry the X-On-Behalf-Of-Company header.
      scheme: bearer
      type: http

````

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