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

# List payments

`GET /v1/payments`

Query a list of payments, which includes payins, refunds, chargebacks, and ACH returns, given optional search criteria.

## Query parameters

- `id` string — The unique identifier for a Payin, Refund, or Chargeback.
- `deposit_id` string
- `status` string[]
- `payment_type` string[]
- `source` string[]
- `due_date.start` string, date-time
- `due_date.end` string, date-time
- `sort_by` 'amount' | 'billing_contact_name' | 'created_at' | 'expected_deposit_date' | 'merchant_id' | 'method_type' | 'payment_id' | 'payment_type' | 'status' | 'acquirer_ref' | 'due_date'
- `omit_total_results` boolean

## Parameters

- `#/paths/~1v1~1payins/get/parameters/0` — unresolved $ref
- `#/paths/~1v1~1device_registrations/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_id` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/2` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/3` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/4` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/7` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/8` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/9` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/10` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/11` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/13` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/14` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/15` — unresolved $ref
- `#/paths/~1v1~1payins/get/parameters/16` — unresolved $ref

## Response `200`

OK

- object
  - `status` Status — unresolved $ref
  - `errors` Errors — unresolved $ref

## Other responses

- `400` — unresolved $ref
- `401` — unresolved $ref
- `403` — unresolved $ref
- `5XX` — unresolved $ref

---

[API](https://skmtc.dev/rainforestpay/apis/authentication.md) · [All operations](https://skmtc.dev/rainforestpay/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rainforestpay/authentication/revisions/529a0dab0f90/schema)