Sign in
Merchants

List merchants

Query a list of merchants given optional search criteria.

get/v1/merchants

Query parameters

platform_idstring

The unique platform identifier.

Prefix is "plt" in production and "sbx_plt" in sandbox.

merchant_idstring

The unique merchant identifier.

Prefix is "mid" in production and "sbx_mid" in sandbox.

namestring

Optional merchant name by which to search merchants.

statusstring[]

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

ACTIVE DEACTIVATED ONBOARDING PENDING SUSPENDED

billing_profile_idstring[]

Optional billing profile ID by which to search merchants.

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.

updated_at.startstring date-time

Last updated on or after in UTC RFC 3339 format.

updated_at.endstring date-time

Last updated on or before in UTC RFC 3339 format.

latest_merchant_application_statusstring[]

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

[
  "CREATED"
]
sort_by'merchant_id' | 'name' | 'status' | 'created_at' | 'updated_at'

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.

offsetnumber

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

Headers

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

Parameters

#/paths/~1v1~1merchants/get/parameters/8 — unresolved $ref
#/paths/~1v1~1merchants/get/parameters/9 — 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