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

# List payments

`GET /payments`

**Plan: Paid API.**

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

OK

- object
  - `stats` PaginationStats — Pagination metadata attached as `stats` (or `meta` on assets) to index responses. The **quotes** list uses a different block - see `QuoteListStats`.
    - `totalCount` integer
    - `page` integer
    - `perPage` integer
    - `totalPages` integer
    - `prevPage` integer, nullable
    - `nextPage` integer, nullable
    - `outOfRange` boolean
  - `payments` PaymentListItem[]
    - `id` string, uuid
    - `txnNumber` string
    - `paymentMethodId` string, uuid, nullable
    - `amountInCents` integer, nullable — dollars * 10000.
    - `balanceInCents` integer, nullable — dollars * 10000.
    - `appliedPaymentsInCents` integer, nullable — dollars * 10000.
    - `paidOn` string, date, nullable
    - `posted` boolean
    - `company` NamedRef — Lightweight reference to a related record.
      - `id` string, uuid
      - `name` string

## Other responses

- `401` — Missing/expired credentials, an index request without a required filter, or the plan does not include this endpoint.

---

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