Search Payment Requests

Searches the payment requests submitted to you: your review queue.

Use it to filter and sort the queue, for example all PENDING_APPROVAL requests from one payee. Drafts are never
returned, whatever you filter on. The results come from a search index and can be a few seconds behind: read the request
with Get Received Payment Request before you approve or reject it.

Requires the Payment Requests permission (see List Received Payment Requests).

Filterable and sortable fields: requestId, type, status, title, amount, currencyCode, invoiceNumber,
invoiceDate, dueDate, attachmentCount, requester.payeeId, requester.email, requester.firstName,
requester.lastName, requester.businessName, payments.paymentId, payments.batchId, payments.paymentStatus,
paymentFailure.code, submittedAt, decidedAt, createdAt, updatedAt.

pageSize is 10–1000 (default 100), and page × pageSize cannot exceed 10,000. An account with no requests yet returns
an empty page.

Errors

  • 400 VALIDATION_ERROR: a filter or sort names a field not listed above, or pageSize or page is out of range
  • 400 INVALID_REQUEST: the search engine rejected the filter
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
object

Conditions a record must match. Omit to return every record. Use all for AND and any for OR; groups can be nested.

sort
array of objects

Sort order, applied in the order listed.

sort
number
10 to 1000
Defaults to 100

Records per page, between 10 and 1000. Defaults to 100. page × pageSize cannot exceed 10,000; narrow the filter to reach
older records.

number
≥ 1
Defaults to 1

Page to return, starting at 1. Defaults to 1.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json