List payins

Query a list of payins given optional search criteria.

Query Params
string

Optional merchant name by which to filter.

string
enum

Payment method type to filter by. Provide parameter multiple times to filter by multiple payment method types.

Allowed:
string
length between 1 and 50

Optional billing contact name by which to filter.

status
array of strings

One or more payin statuses to filter by. Provide parameter multiple times to filter by multiple payin status types.

AUTHORIZED CANCELED CREATED FAILED IN_REVIEW PRESENTING PROCESSING RETURNED SUCCEEDED

status
source
array of strings

One or more payin sources to filter by. Provide parameter multiple times to filter by multiple payin sources.

source
string

Filter by metadata stored on the entity by passing a map of key-value pairs to filter on. The key should be valid JSONPath to a corresponding metadata key.

For example, an entity created with the following metadata

"account": {
  "id": "acct_123"
}

could have the following metadata filter to find entities with the metadata account id:

?metadata[$.account.id]=acct_123
date-time

Created on or after in UTC RFC 3339 format.

date-time

Created on or before in UTC RFC 3339 format.

date

Expected to be deposited on or after in UTC RFC 3339 format.

date

Expected to be deposited on or before in UTC RFC 3339 format.

string
enum

Optional value by which to sort the result set. Default sort by is created_at.

string
enum

Order in which to return the sorted results; ascending or descending. Default sort order is descending.

Allowed:
number
≤ 1000
Defaults to 1000

The maximum number of results to return.

number
≥ 0
Defaults to 0

The offset of the first result to return; zero-based.

Headers
string
enum
Defaults to 2024-10-16
Allowed:
Responses

Language
Credentials
Bearer
APIKey
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json