---
title: "Get payments (PMS)"
method: GET
path: "/consumers/{consumer_id}/pms/payments"
tags: ["Property Management System", "Payments"]
---

# Get payments (PMS)

`GET /consumers/{consumer_id}/pms/payments`

Returns a list of payments

## Path parameters

- `consumer_id` string, uuid, required

## Query parameters

- `page` integer
- `size` integer
- `date_from` string, date, required
- `date_to` string, date, required

## Response `200`

Successful Response

- ChiftPagePMSPaymentItem
  - `items` PMSPaymentItem[], required
    - `id` string, nullable — Unique identifier of the payment
    - `source_ref` Ref, required
      - `id` string, nullable — Technical id in the target software
      - `model` string, nullable — Name of the model/entity in the target software
    - `payment_method_id` string, nullable — Unique identifier of the payment method used for the payment
    - `payment_method_name` string, nullable — Chift's name of the payment method used for the payment
    - `total` number, required — Total amount of the payment
    - `tip` number, nullable — Total amount of the tips of the payment. Tips are not part of the total of the payment
    - `status` 'Pending' | 'Completed' | 'Canceled' | 'Failed' | 'Unknown' | 'Authorised'
    - `currency` string, nullable — Currency of the payment
    - `date` string, date-time, nullable — Date of the payment
    - `invoice_ref` string, nullable — Reference of the invoice linked to the payment
    - `partner_id` ChiftId
      - `id` string, required — Technical id in Chift
      - `source_ref` Ref, required
        - `id` string, nullable — Technical id in the target software
        - `model` string, nullable — Name of the model/entity in the target software
    - `description` string, nullable — Description of the payment
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required

## Other responses

- `400` — Bad Request
- `405` — Method Not Allowed
- `422` — Validation Error
- `502` — Bad Gateway

---

[API](https://skmtc.net/chift/apis/chift-api.md) · [All operations](https://skmtc.net/chift/apis/chift-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/chift/chift-api/revisions/b5f1214a482a/schema)