---
title: "List payins"
method: GET
path: "/v1/payins"
tags: ["Payins"]
---

# List payins

`GET /v1/payins`

## Request

- Base URL: `https://api.sandbox.rainforestpay.com`
- URL: `https://api.sandbox.rainforestpay.com/v1/payins`
- Auth: HTTP bearer

Query a list of payins given optional search criteria.

## Query parameters

- `merchant_name` string
- `method_type` 'CARD' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'ACH' | 'PLAID_ACH': The type of payment method.
- `billing_contact_name` string
- `status` string[]
- `source` string[]
- `metadata` string
- `created_at.start` string, date-time
- `created_at.end` string, date-time
- `expected_deposit_date.start` string, date
- `expected_deposit_date.end` string, date
- `sort_by` 'amount' | 'billing_contact_name' | 'created_at' | 'expected_deposit_date' | 'merchant_id' | 'method_type' | 'payin_id' | 'status'
- `sort_order` 'asc' | 'desc'
- `limit` number
- `start_key` string
- `offset` number
- `omit_total_results` boolean

## Headers

- `Rainforest-Api-Version` '2024-10-16' | '2023-12-01'

## Parameters

- `#/paths/~1v1~1device_registrations/post/responses/200/content/application~1json/schema/properties/data/properties/merchant_id` (unresolved $ref)

## Response `200`

OK

- object
  - `status` 'SUCCESS' | 'ERROR': Status of the request. If the request status code is 2XX, then the `status` will be `SUCCESS`. If the request status code is 4XX or 5XX, then the `status` will be `ERROR`.
  - `data` object
    - `total_results` integer: Total number of results available. This value will be -1 if the query parameter `omit_total_results` is set to true.
    - `last_key` unknown
    - `results` Data[]: List of payins. (unresolved $ref)
  - `errors` object[]: List of errors, if applicable.
    - `field` string: The field in the request that had an error, if applicable.
    - `code` string: The code describing the error.
    - `message` string: The description of the error related to the field.

## Other responses

- `400`: Bad request, check for validation errors.
- `401`: Authorization missing or invalid.
- `403`: Authorization insufficient for requested action.
- `5XX`: Unexpected error.

---

[API](https://skmtc.dev/rainforestpay/apis/payments.md) - [All operations](https://skmtc.dev/rainforestpay/apis/payments/llms.txt) - [OpenAPI document](https://skmtc.dev/rainforestpay/apis/payments/revisions/9d7d0b1553a8?raw)