API Reference

List merchants

get
https://api.sandbox.rainforestpay.com/v1/merchants

Query a list of merchants given optional search criteria.

Query Params
string

The unique platform identifier.

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

string

The unique merchant identifier.

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

string

Optional merchant name by which to search merchants.

status
array of strings

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

ACTIVE DEACTIVATED ONBOARDING PENDING SUSPENDED

status
billing_profile_id
array of strings

Optional billing profile ID by which to search merchants.

billing_profile_id
date-time

Created on or after in UTC RFC 3339 format.

date-time

Created on or before in UTC RFC 3339 format.

date-time

Last updated on or after in UTC RFC 3339 format.

date-time

Last updated on or before in UTC RFC 3339 format.

latest_merchant_application_status
array of strings

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

latest_merchant_application_status
string
enum

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

Allowed:
string
enum

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

Allowed:
number
≤ 2000
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

Updated 7 months ago

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