GET
/
payments
/
search
Search payments
curl --request GET \
  --url https://api.next.orenda.finance/payments/search \
  --header 'Authorization: Bearer <token>'
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.next.orenda.finance/payments/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests

url = "https://api.next.orenda.finance/payments/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
{
  "success": true,
  "result": {
    "data": "https://orenda-reports.s3.eu-west-1.amazonaws.com/payments/payments-export-2026-06-29.csv?X-Amz-Expires=3600&X-Amz-Signature=EXAMPLE"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

programId
string
required

The program to scope results to. Required unless allPrograms=true is passed. Multi-program operators are bounded to their entitled programs.

page
integer
default:1

1-based page number. Defaults to 1.

Required range: x >= 1
limit
integer

Maximum number of items per page.

Required range: x >= 1
allPrograms
enum<string>

When true, searches across all of the operator's entitled programs instead of a single programId.

Available options:
true,
false
status
string

Filter by status. Comma-separated for multi-select.

fromDate
string<date-time>

Lower bound (inclusive) on record date, ISO 8601.

toDate
string<date-time>

Upper bound (inclusive) on record date, ISO 8601.

resultType
enum<string>
default:file

Result format. Defaults to file for this endpoint (a presigned S3 CSV URL). Pass json for inline results in the standard envelope.

Available options:
json,
file
filePrefix
string

Customises the filename of the exported CSV when resultType=file.

type
string

Filter by payment type. Comma-separated for multi-select.

subType
string

Filter by payment sub-type (e.g. SEND). Comma-separated for multi-select.

excludedProviders
string

Exclude payments from the given providers. Comma-separated for multi-select.

Response

A presigned export URL by default, or inline JSON results when resultType=json.

Inline JSON results, or — when resultType=file — a presigned CSV export URL.

success
boolean
Example:

true

result
object