COcollectwise

List Payments

Changed on

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

get/payments

Request

  • Base URL
    https://collectwiseapi.com
  • URL
    https://collectwiseapi.com/payments
  • Auth
    API key in header collectwise_key

Query parameters

start_datestring required

Start of date range, inclusive. Accepts YYYY-MM-DD (interpreted as 00:00:00 UTC) or a full ISO 8601 UTC timestamp like 2026-06-18T04:00:00Z

end_datestring required

End of date range. Accepts YYYY-MM-DD (covers that entire UTC day, including the final sub-second) or a full ISO 8601 UTC timestamp (inclusive). Must be on or after start_date and within 366 days of it.

status'success' | 'failed' | 'declined' | 'error'

Filter by payment status

payment_type'flat' | 'subscription' | 'settlement' | 'remainder'

Filter by payment type. flat = one-time payment, subscription = payment-plan installment, settlement = settlement payment, remainder = remainder charge after a partial payment

payment_method'ach' | 'card'

Filter by payment method (matched case-insensitively)

limitinteger

Page size. Defaults to 50, maximum 100.

starting_afterstring

Pagination cursor: the id of the last payment on the previous page (also returned as pagination.next_cursor). Must reference a payment of your organization inside the queried date range.

Headers

x-cw-timestampstring

Required together with x-cw-signature when signing is enabled for this key or organization. POST /security/verify also requires signing whenever a usable secret exists. Canonical Unix seconds, within ±300 seconds. See API Access for CW1 signing.

x-cw-signaturestring

CW1 HMAC-SHA256 signature: v1= followed by 64 lowercase hex digits. Use the decoded 32-byte signing secret and exact request bytes. See API Access.

Response

Payments retrieved successfully

objectstring

Object type identifier

countinteger

Number of payments on this page

Example response

{
  "object": "list.payments",
  "period": {
    "start_date": "2026-06-18",
    "end_date": "2026-06-18"
  },
  "pagination": {
    "limit": 50,
    "has_more": false,
    "next_cursor": null
  },
  "count": 1,
  "payments": [
    {
      "id": "pi_3RxT81GhIJk2LmNo",
      "object": "payment",
      "debtor_id": "ACC482910",
      "creditor_name": "Lakeside Regional Hospital",
      "client_name": "Sunrise Medical Group",
      "call_id": "call_9f2ab61c3d",
      "amount": 245.16,
      "currency": "usd",
      "processor": "stripe",
      "payment_type": "flat",
      "payment_method": "CARD",
      "status": "success",
      "transaction_id": "ch_3RxT81GhIJk2LmNo",
      "phone": "+15555550123",
      "recurrence_rule": null,
      "total_installments": null,
      "next_payment_date": null,
      "created_at": "2026-06-18T14:22:07.318Z"
    }
  ]
}

Changes

  • 95fad0d2f369Revision changes
    • info

      added the new optional header request parameter x-cw-signature

    • info

      added the new optional header request parameter x-cw-timestamp

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status