Searches all your payments, across batches, with filters, sorting and pages.
Requires the Read permission. See /docs/getting-started-with-search for the filter syntax.
Fields. filter and sort accept only these fields: id, batchId, batchName, referenceId, ledgerAccount,
status, completed, virtualPayment, paymentCategory, taxJurisdiction, payorMemo, cancellationReason, sourceAmount.wholeValue,
refundAmount.wholeValue, chargedServiceFee.wholeValue, refundedServiceFee.wholeValue, payee.id, payee.referenceId,
payee.email, payee.onboarded, payee.payable, payee.currentStep, isSubmittable, isAutoSubmittable, isAutoSubmitOn,
lastActivity, auditInfo.createdBy, auditInfo.updatedBy, auditInfo.createdAt, auditInfo.updatedAt, tags.key,
tags.value, tagKeys. Amounts are compared in minor units (wholeValue). Filter status with the values the API returns
(DRAFT, SUBMITTED, …).
Paging. pageSize is 10 to 1000 (default 100) and page × pageSize cannot exceed 10,000. Results reflect changes within a
few seconds.
Errors
400 VALIDATION_ERROR: a field is not in the list above, or a paging limit is exceeded (INVALID_PAGE_TOO_HIGH).400 INVALID_REQUEST: the search could not run. Check your filter syntax.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||