Skip to main content

Filtering

Many endpoints support advanced filtering using MongoDB Query Language (MQL). This page explains how to build filter queries to retrieve specific data from the API.

Updated over a month ago

Many endpoints support advanced filtering.

Filtering uses a JSON object representing query criteria in MongoDB Query Language (MQL) format.

Example filter:

{ "paid": true }

More advanced example:

{ "$or": [{ "status": "SETTLED" }, { "$and": [{ "transactionAmount": { "$gte": 100, "$lte": 500 } }, { "currency": "USD" }]}] }

Filtering allows developers to retrieve data such as:

  • transactions above a certain amount

  • transactions within a specific date range

  • disputes with specific statuses

Refer to the API documentation for supported fields.

Did this answer your question?