RArainforestpay
Payins

List payins

Query a list of payins given optional search criteria.

get/v1/payins

Request

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

Query parameters

merchant_namestring

Optional merchant name by which to filter.

method_type'CARD' | 'APPLE_PAY' | 'GOOGLE_PAY' | 'ACH' | 'PLAID_ACH'

The type of payment method.

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

billing_contact_namestring

Optional billing contact name by which to filter.

statusstring[]

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

[
  "PROCESSING"
]
sourcestring[]

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

metadatastring

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
created_at.startstring date-time

Created on or after in UTC RFC 3339 format.

created_at.endstring date-time

Created on or before in UTC RFC 3339 format.

expected_deposit_date.startstring date

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

expected_deposit_date.endstring date

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

sort_by'amount' | 'billing_contact_name' | 'created_at' | 'expected_deposit_date' | 'merchant_id' | 'method_type' | 'payin_id' | 'status'

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

sort_order'asc' | 'desc'

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

limitnumber

The maximum number of results to return.

start_keystring

A key used to indicate the starting point for the next page of results. This value should be set to the last_key returned by the previous paginated request.

offsetnumber

Offset has been deprecated. Utilize start_key and last_key for pagination.

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

omit_total_resultsboolean

The total_results field in the response will be set to -1. Allows for faster query results.

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

OK

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.

Changes

No recorded changes to this operation across all 1 revision of this API.