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

# List payments

`GET /payments`

Use when listing or searching payments (e.g. reconciliation UI or customer payment history). Returns a paginated list; supports filtering by customer, invoice, status.

## Query parameters

- `currency` string
- `destination_id` string
- `destination_type` string
- `end_time` string
- `expand` string
- `gateway_payment_id` string
- `gateway_tracking_id` string
- `limit` integer
- `offset` integer
- `order` 'asc' | 'desc'
- `payment_gateway` string
- `payment_ids` string[]
- `payment_method_type` string
- `payment_status` string
- `sort` string
- `start_time` string
- `status` 'published' | 'deleted' | 'archived'

## Response `200`

Paginated payments

- ListPaymentsResponse
  - `items` PaymentResponse[]
    - `amount` string
    - `attempts` PaymentAttemptResponse[]
      - `attempt_number` integer
      - `created_at` string, date-time
      - `created_by` string
      - `error_message` string
      - `id` string
      - `metadata` TypesMetadata
      - `payment_id` string
      - `tenant_id` string
      - `updated_at` string, date-time
      - `updated_by` string
    - `created_at` string, date-time
    - `created_by` string
    - `currency` string
    - `destination_id` string
    - `destination_type` 'INVOICE' | 'CUSTOMER'
    - `environment_id` string
    - `error_message` string
    - `failed_at` string, date-time
    - `gateway_metadata` TypesMetadata
    - `gateway_payment_id` string
    - `gateway_tracking_id` string
    - `id` string
    - `idempotency_key` string
    - `invoice_number` string
    - `metadata` TypesMetadata
    - `payment_gateway` string
    - `payment_method_id` string
    - `payment_method_type` 'CARD' | 'ACH' | 'OFFLINE' | 'CREDITS' | 'PAYMENT_LINK' | 'UPI'
    - `payment_status` 'INITIATED' | 'PENDING' | 'PROCESSING' | 'SUCCEEDED' | 'OVERPAID' | 'FAILED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'VOIDED'
    - `payment_url` string
    - `refunded_at` string, date-time
    - `save_card_and_make_default` boolean
    - `succeeded_at` string, date-time
    - `tenant_id` string
    - `track_attempts` boolean
    - `updated_at` string, date-time
    - `updated_by` string
    - `voided_at` string, date-time
  - `pagination` TypesPaginationResponse
    - `limit` integer
    - `offset` integer
    - `total` integer

## Other responses

- `400` — Invalid request
- `500` — Server error

---

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