Search Payment Requests

Searches the payment requests payees have submitted to you: the review queue.

Drafts are never returned. They are a payee's scratchpad and are excluded whatever you filter on,
so asking for status = DRAFT answers nothing rather than answering with drafts.

Every figure is whatever the request said when it was last indexed, which is seconds behind at
best. Right for a grid, wrong for a decision — read the request itself before approving it,
or you may approve a version the payee has since changed.

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 capped at 100. An environment with no requests yet answers an empty result rather
than an error.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
object

Search criteria for filtering results

sort
array of objects

Fields to sort by

sort
number

Number of results to return

number

Page number to return

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