Skip to main content
GET
List payee checks

What this endpoint does

Lists the payee checks run for this tenant account, newest first.

When to use it

Use it to review recent checks, find a check to reuse as payeeCheck.checkId, or reconcile the payee-check line on your invoice. Page with cursor and limit.

Before you call

Authenticate with an API key that can read payees — a scoped key must include payees:read (payees:write implies it). History stays readable when Confirmation of Payee is disabled for your account.

Money and balance effect

This is a read-only request. It does not reserve, debit, credit, or settle money.

States and completion

Each check is final when created. The list includes checks run on their own and checks run while creating a payment route or beneficiary.

Safe retries

GET requests are read-only and may be retried with normal exponential backoff. Do not send an Idempotency-Key. Read Confirm payee for the complete workflow.

Authorizations

Authorization
string
header
required

Send the same Wayex API key as Authorization: Bearer <key>.

Query Parameters

cursor
string
limit
number
Example:

25

Response

200 - application/json

A cursor-paginated page of payee checks.

data
object[]
required

The page of results, newest first.

hasMore
boolean
required

Whether a further page exists after this one.

nextCursor
string | null
required

Opaque cursor to pass as cursor to fetch the next page, or null at the end.