---
title: "Retrieve a paginated list of payments by query parameter(s)"
method: GET
path: "/payments"
tags: ["Payments"]
---

# Retrieve a paginated list of payments by query parameter(s)

`GET /payments`

## Query parameters

- `payerId` string, uuid, required
- `offset` integer
- `limit` integer

## Headers

- `Trace-Id` string
- `End-User-Agent` string
- `End-User-Ip` string
- `End-User-OS` string
- `End-User-Device-Id` string
- `End-User-Device-Manufacturer` string
- `End-User-Device-Model` string

## Response `200`

A list of Payments

- object
  - `data` Payment[]
    - `id` string, uuid
    - `fees` Fee[]
      - `amount` object — Amount that will be credited to Recipient
        - `value` number, required — Value of the currency between 1 and 99999999.99
        - `currency` 'USD', required — Currency value
      - `type` 'PLASTIQ_SERVICE_FEE' | 'PLASTIQ_CROSS_BORDER_FEE' | 'DELIVERY_FEE' | 'EXPEDITED_PROCESSING_FEE' | 'EXPEDITED_HANDLING_FEE' — The type of fee applied to the payment
      - `rate` string — The rate of the fee assessed, presented in percentage.
    - `sourceAmount` object — Amount that will be credited to Recipient
      - `value` number, required — Value of the currency between 1 and 99999999.99
      - `currency` 'USD', required — Currency value
    - `targetAmount` object — Amount that will be credited to Recipient
      - `value` number, required — Value of the currency between 1 and 99999999.99
      - `currency` 'USD', required — Currency value
    - `paymentMethod` PaymentMethodId
      - `id` string, uuid, required
    - `recipient` RecipientId
      - `id` string, uuid, required
    - `payer` PayerId
      - `id` string, uuid, required
    - `details` PaymentDetails
      - `accountName` string — The name of the account. Used by the receiving entity for reconciling payments.
      - `accountNumber` string — The invoice or account number. Used by the receiving entity for reconciling payments.
      - `memo` string — Short description of the payment. Used by the receiving entity for reconciling payments.
      - `disbursementInformation` object — The disbursement bank account or originator account for the payment.
        - `accountLastFour` string — Last four digits of the disbursement bank account number
        - `routingNumber` string — Routing number for the disbursement bank account
        - `bankName` string — Name of the bank for the disbursement account
      - `traceInformation` object — The trace information for locating the payment.
        - `reference` string — Number or ID of the trace information.
    - `deliveryDate` string, date
    - `createdAt` string, date-time
    - `status` 'CHARGED' | 'UNDER_REVIEW' | 'IN_TRANSIT' | 'DEPOSITED' | 'REFUNDED' | 'CARD_DECLINED' | 'NOT_CAPTURED' | 'TRANSIT_EXCEPTION' — The current state of a Payment
    - `statusReasons` StatusReason[]
      - `code` string, required
      - `message` string, required
    - `sourceDescriptor` string
    - `targetDescriptor` string
  - `pagination` PaginationObject
    - `offset` integer
    - `limit` integer
    - `total` integer
    - `hasNextPage` boolean

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `500` — Internal Server Error

---

[API](https://skmtc.dev/plastiq/apis/plastiq-public-api.md) · [All operations](https://skmtc.dev/plastiq/apis/plastiq-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/plastiq/plastiq-public-api/revisions/cfd776dd9ac5/schema)