Skip to main content
GET
/
v1
/
mandates
List mandates
curl --request GET \
  --url https://api.paywise.de/v1/mandates/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "href": "<string>",
      "debtor": {
        "name": "<string>"
      },
      "legal_stage": "extrajudicial",
      "processing_state": "in_progress",
      "payment_state": "unpaid",
      "legal_claim_balance": {
        "balance_of_costs_interest_bearing": {
          "value": "<string>",
          "currency": "EUR"
        },
        "balance_of_costs_interest_free": {
          "value": "<string>",
          "currency": "EUR"
        },
        "balance_of_interest_on_costs": {
          "value": "<string>",
          "currency": "EUR"
        },
        "balance_of_interest_on_principal_claim": {
          "value": "<string>",
          "currency": "EUR"
        },
        "balance_of_principal_claim": {
          "value": "<string>",
          "currency": "EUR"
        },
        "total_balance": {
          "value": "<string>",
          "currency": "EUR"
        },
        "legal_claim_of_costs_interest_bearing": {
          "value": "<string>",
          "currency": "EUR"
        },
        "legal_claim_of_costs_interest_free": {
          "value": "<string>",
          "currency": "EUR"
        },
        "legal_claim_of_interest_on_costs": {
          "value": "<string>",
          "currency": "EUR"
        },
        "legal_claim_of_interest_on_principal_claim": {
          "value": "<string>",
          "currency": "EUR"
        },
        "legal_claim_of_principal_claim": {
          "value": "<string>",
          "currency": "EUR"
        },
        "total_legal_claim": {
          "value": "<string>",
          "currency": "EUR"
        },
        "payment_on_costs_interest_bearing": {
          "value": "<string>",
          "currency": "EUR"
        },
        "payment_on_costs_interest_free": {
          "value": "<string>",
          "currency": "EUR"
        },
        "payment_on_interest_on_costs": {
          "value": "<string>",
          "currency": "EUR"
        },
        "payment_on_interest_on_principal_claim": {
          "value": "<string>",
          "currency": "EUR"
        },
        "payment_on_principal_claim": {
          "value": "<string>",
          "currency": "EUR"
        },
        "total_payment": {
          "value": "<string>",
          "currency": "EUR"
        },
        "updated": "2023-11-07T05:31:56Z"
      },
      "total_mandate_amount": {
        "value": "<string>",
        "currency": "EUR"
      },
      "status_updates": [
        {
          "title": "<string>",
          "description": "<string>",
          "legal_stage": "extrajudicial",
          "processing_state": "in_progress",
          "created": "2023-11-07T05:31:56Z",
          "downloads": [
            {
              "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "filename": "<string>",
              "mime_type": "<string>",
              "file_size": 123,
              "download_url": "<string>"
            }
          ],
          "id": "<string>"
        }
      ],
      "requests_to_client_summary": {
        "total_count": "<string>",
        "unanswered_count": "<string>",
        "has_pending": "<string>",
        "items": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "href": "<string>",
            "title": "<string>",
            "description_short": "<string>",
            "answered": true,
            "allowed_answer_types": "<string>",
            "created": "2023-11-07T05:31:56Z",
            "answered_at": "2023-11-07T05:31:56Z"
          }
        ]
      },
      "archived": true,
      "created": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "reference_number": "<string>",
      "further_reference_numbers": [
        "<string>"
      ],
      "claims": [
        {
          "href": "<string>",
          "id": "<string>",
          "payments": [
            {
              "href": "<string>",
              "id": "<string>"
            }
          ]
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
archived
boolean

Filter by archived status of the mandate

​
debtor
string<uuid>

Filter by our ID of the debtor

​
debtor_organization_name
string

Filter by the name of the debtor's organization (in case debtor is an organization and has the 'organization' object associated with it)

​
debtor_person_first_name
string

Filter by the first name of the debtor (in case debtor is a person has the 'person' object associated with it). Can be combined with debtor_person_last_name

​
debtor_person_last_name
string

Filter by the last name of the debtor (in case debtor is a person and has the 'person' object associated with it). Can be combined with debtor_person_first_name

​
debtor_your_reference
string

Filter by the field your_reference of the mandate's debtor

​
legal_stage
string

Filter by the legal stage of the mandate

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
payment_state
string

Filter by the payment state of the mandate

​
processing_state
string

Filter by the processing state of the mandate

​
reference_number
string

Filter by the reference number of the mandate

Response

200 - application/json
​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"

​
results
object[]