---
title: "List Payments"
method: GET
path: "/payments"
---

# List Payments

`GET /payments`

Returns payments collected for your organization over a date range, newest first.

## Query parameters

- `start_date` string, required
- `end_date` string, required
- `status` 'success' | 'failed' | 'declined' | 'error'
- `payment_type` 'flat' | 'subscription' | 'settlement' | 'remainder'
- `payment_method` 'ach' | 'card'
- `limit` integer
- `starting_after` string

## Response `200`

Payments retrieved successfully

- PaymentsList
  - `object` string — Object type identifier
  - `period` object
    - `start_date` string — The start_date you supplied, echoed verbatim
    - `end_date` string — The end_date you supplied, echoed verbatim
  - `pagination` object
    - `limit` integer — Page size applied to this response
    - `has_more` boolean — Whether more payments exist beyond this page
    - `next_cursor` string, nullable — Pass as starting_after to fetch the next page; null on the last page
  - `count` integer — Number of payments on this page
  - `payments` Payment[]
    - `id` string — Payment identifier. Stable across polls and unique per payment - use this as your idempotency key when posting to your system.
    - `object` string — Object type identifier
    - `debtor_id` string, nullable — The account reference you supplied in the placement file
    - `client_name` string — Client name the payment was collected under
    - `call_id` string, nullable — Call that produced the payment, or a pymts_-prefixed id for payment-link records
    - `amount` number, nullable — Payment amount in USD (decimal, not minor units)
    - `currency` string
    - `processor` string — Payment processor that handled the charge
    - `payment_type` 'flat' | 'subscription' | 'settlement' | 'remainder' — flat = one-time, subscription = payment-plan installment, settlement = settlement payment, remainder = remainder charge after a partial payment
    - `payment_method` string — Payment method as stored (letter case may vary, e.g. CARD or ACH)
    - `status` 'success' | 'failed' | 'declined' | 'error' — Payment outcome
    - `transaction_id` string, nullable — Processor transaction id where the processor returned one. May be null - prefer id for idempotency.
    - `phone` string, nullable — Phone number associated with the payment, derived from the originating call or the debtor record. Null when neither is available (e.g. payment-link records).
    - `recurrence_rule` string, nullable — Recurrence rule for payment-plan installments; null on one-time payments
    - `total_installments` string, nullable — Total number of installments in the plan; null on one-time payments
    - `next_payment_date` string, nullable — Next scheduled installment date (ISO 8601 UTC); null on one-time payments
    - `created_at` string — When the payment was recorded (ISO 8601 UTC with millisecond precision)

## Other responses

- `400` — Invalid request - missing or malformed dates, a date range over 366 days, an unknown filter value, a repeated query parameter, or a starting_after cursor outside the queried range
- `401` — API key is not associated with an organization. Contact CollectWise support.
- `403` — Missing or invalid API key
- `500` — Internal server error

---

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