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, orpageSizeorpageis out of range400 INVALID_REQUEST: the search engine rejected the filter
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
