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

# List payments

`GET /payments`

## Request

- Base URL: `https://app-sandbox.resolvepay.com/api`
- URL: `https://app-sandbox.resolvepay.com/api/payments`
- Auth: one of:
  - HTTP bearer
  - HTTP basic
- TypeScript: <https://skmtc.dev/resolvepay/apis/resolve-api-reference/docs/payments/get.ts> (a function with typed inputs; its response is checked against the schema)

Return a list of payments.

## Query parameters

- `limit` integer
- `page` string
- `filter` object
  - `customer_id` object
    - `eq` string
  - `status` object
    - `eq` 'pending' | 'in_transit' | 'in_review' | 'paid' | 'failed' | 'canceled'
  - `amount` object
    - `eq` number
    - `gt` number
    - `lt` number
    - `gte` number
    - `lte` number
- `sort` 'id' | '-id' | 'created_at' | '-created_at' | 'amount' | '-amount'

## Response `200`

A paginated list of payments.

- PaymentListResponse
  - `count` integer
  - `limit` integer
  - `page` integer
  - `results` Payment[]
    - `id` string: Unique identifier for the payment.
    - `customer_id` string: Unique identifier of the customer that made the payment.
    - `source` 'api' | 'merchant_user' | 'admin_user' | 'customer_user' | 'payment_gateway' | 'check' | 'guest_checkout': Source of the payment.
    - `amount` number, double: Amount of the payment in USD.
    - `method` 'check' | 'ach_debit' | 'direct_deposit' | 'card' | 'merchant' | 'unapplied_payment_adjustment' | 'credit_note' | 'adjustment' | 'wire': Method of payment made by the customer.
    - `status` 'pending' | 'in_transit' | 'in_review' | 'paid' | 'failed' | 'canceled': Status of the payment. - `pending` - Payment is pending processing. - `in_transit` - Payment has been processed and is in transit. - `in_review` - Payment is being reviewed. - `paid` - Payment has been confirmed and applied to the customer's account. - `failed` - Payment failed confirmation (e.g., bank transfer or credit card payment rejected). - `canceled` - Payment was canceled by request.
    - `created_at` string, date-time: Date the payment was created.
    - `paid_at` string, date-time: Date the payment was confirmed by Resolve and applied to the customer's account.
    - `canceled_at` string, date-time: Date the payment was canceled by request.
    - `failed_at` string, date-time: Date the payment failed processing.
    - `processed_at` string, date-time: Date the payment was processed by Resolve.
    - `scheduled_at` string, date-time: Date the payment was scheduled for processing, if applicable.
    - `processing_fee` number, double: Processing fee for the payment.
    - `canceled_code` string: Code indicating the reason the payment was canceled.
    - `failed_code` string: Code indicating the reason the payment failed processing.
    - `dispute_code` string: Code indicating the reason the payment is in dispute.
    - `forward_reason_code` 'ach' | 'check' | 'wire' | 'credit_card' | 'other': Reason code for a forward payment. Use this field to trigger the forward-payment flow. A forward payment is how you tell Resolve that the customer already paid you and that Resolve should collect its portion from the forwarded amount.
    - `forward_reason_message` string: Free-form reason text for a forward payment. Required when `forward_reason_code` is `other`.
    - `payment_links` object[]: List of records the payment is applied to.
      - `record_id` string: ID of the record.
      - `record_type` 'invoice': Type of record the payment is applied to.
      - `amount` number, double: Amount applied to this record.
    - `created_by_user_id` string: ID of the user who created the payment, if applicable.

## Other responses

- `400`: Bad request error
- `401`: Unauthorized error
- `429`: Rate limit error

---

[API](https://skmtc.dev/resolvepay/apis/resolve-api-reference.md) - [All operations](https://skmtc.dev/resolvepay/apis/resolve-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/resolvepay/apis/resolve-api-reference/revisions/c62edc454aaa?raw)