---
title: "List payments"
method: GET
path: "/payments"
tags: ["Payments"]
---

# List payments

`GET /payments`

## Request

- Base URL: `https://www.ruddr.io/api/workspace`
- URL: `https://www.ruddr.io/api/workspace/payments`
- Auth: HTTP bearer

## Query parameters

- `startingAfter` string
- `endingBefore` string
- `limit` integer
- `clientId` string

## Response `200`

200

- object
  - `results` Payment[]: The list of results for the current page.
    - `id` string: The unique identifier for the object.
    - `referenceNumber` string, nullable: The payment reference number (e.g., a check number or wire transfer ID).
    - `receivedOn` string, date: The date the payment was received (`YYYY-MM-DD`).
    - `notes` string, nullable: Additional notes about the payment.
    - `currency` string: The 3-letter ISO 4217 currency code for the payment.
    - `amount` number: The total payment amount.
    - `createdAt` string, date-time: The timestamp when the object was created.
    - `client` object: The client associated with this payment.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the client.
    - `paymentMethod` object, nullable: The payment method used for this payment.
      - `id` string: The unique identifier for the object.
      - `name` string: The name of the payment method.
    - `invoices` object[]: The invoices this payment is applied to.
      - `id` string: The unique identifier for the object.
      - `number` string: The invoice number.
      - `amount` number: The portion of the payment applied to this invoice.
  - `hasMore` boolean: Whether there are more results available after this page.

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/ruddr/apis/ruddr-api.md) · [All operations](https://skmtc.dev/ruddr/apis/ruddr-api/llms.txt) · [OpenAPI document](https://skmtc.dev/ruddr/apis/ruddr-api/revisions/01c3f2a969ba?raw)