> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rails.wayex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List payee checks

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

## 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](https://docs.rails.wayex.com/console/overview.md#confirm-payee) for the complete workflow.


## OpenAPI

````yaml /api-reference/openapi.json get /v1/payee-checks
openapi: 3.0.0
info:
  title: Wayex API
  description: >-
    Wayex APIs for direct customer payment routes and isolated, prefunded
    Treasury accounts. Each API key is bound to one tenant account and its own
    wallet, settings, webhooks, and reporting.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.sandbox.rails.wayex.com
    description: Sandbox — fully simulated providers, no real funds move
  - url: https://api.rails.wayex.com
    description: Production — live rails, real funds move
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Treasury
    description: >-
      Prefunded AUD and stablecoin wallets for one isolated tenant account.
      Fund, pay, convert, withdraw, track, and reconcile without selecting
      another account.
  - name: Customers
    description: >-
      Onboard end customers, run verification, and manage each customer's
      entitlements.
  - name: Payment routes
    description: >-
      Standing deposit instructions per customer. When a customer funds a route,
      Wayex auto-converts at the live rate and pays out/sends — no quote, no
      lock.
  - name: Transfers
    description: >-
      Read the conversion records produced when customers fund payment routes —
      the live activity feed and per-conversion lifecycle timeline — and, on
      client-gated routes, progress or refund a waiting payment.
  - name: Rates
    description: >-
      The live indicative AUD↔stablecoin rate right now — the all-in rate Wayex
      quotes. Indicative only; the binding price is struck when a route's funds
      land, or when you progress a client-gated payment.
  - name: Revenue
    description: Your developer-fee revenue over time.
  - name: Invoices
    description: >-
      Your monthly invoices — Wayex platform fees due, net of your accrued
      developer-fee credit.
  - name: Webhooks
    description: Subscribe to HMAC-signed event webhooks and inspect deliveries.
  - name: API keys
    description: Create, list, and rotate API keys for programmatic access.
  - name: Fees
    description: >-
      Configure your developer fee — the markup withheld from each conversion
      and credited against your monthly invoice.
  - name: Invitations
    description: Accept a team invitation and activate your account.
  - name: Team
    description: Manage your own team — list members and send console invitations.
  - name: Notification settings
    description: >-
      Manage whether Wayex sends customer-facing notification emails on your
      behalf.
paths:
  /v1/payee-checks:
    get:
      tags: []
      summary: List payee checks
      description: >-
        Lists the payee checks run for this tenant account, newest first. 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`.
      operationId: PayeeCheckController2_list_v1
      parameters:
        - name: cursor
          required: false
          in: query
          schema:
            type: string
        - name: limit
          required: false
          in: query
          schema:
            example: 25
            type: number
      responses:
        '200':
          description: A cursor-paginated page of payee checks.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: The page of results, newest first.
                    items:
                      type: object
                      properties:
                        id:
                          description: The payee check id (`pchk_` + 32 hex characters).
                          type: string
                          pattern: ^pchk_[0-9a-f]{32}$
                        type:
                          description: >-
                            What is checked: an AUD bank account (BSB + account
                            number + name) or a PayID.
                          type: string
                          enum:
                            - bank_account
                            - payid
                        bankAccount:
                          description: >-
                            The bank account checked. Present when `type` is
                            `bank_account`.
                          type: object
                          properties:
                            bsb:
                              description: The 6-digit BSB checked.
                              type: string
                              pattern: ^\d{6}$
                            accountNumber:
                              description: The account number checked.
                              type: string
                              minLength: 1
                            accountName:
                              description: The account holder name checked.
                              type: string
                              minLength: 1
                          required:
                            - bsb
                            - accountNumber
                            - accountName
                        payId:
                          description: The PayID resolved. Present when `type` is `payid`.
                          type: object
                          properties:
                            type:
                              description: The PayID type.
                              type: string
                              enum:
                                - email
                                - phone
                                - abn
                            value:
                              description: The PayID resolved.
                              type: string
                              minLength: 1
                          required:
                            - type
                            - value
                        result:
                          description: >-
                            The outcome of the check: `match` (the name
                            matches), `close_match` (the name is close to the
                            registered name), `no_match` (the name does not
                            match), `not_found` (no such account or PayID) or
                            `closed` (the account is closed). A resolved PayID
                            is `match`.
                          type: string
                          enum:
                            - match
                            - close_match
                            - no_match
                            - not_found
                            - closed
                        indicator:
                          description: >-
                            The icon to show with the result: `tick`
                            (confirmed), `warning` (close match), `cross` (not
                            confirmed) or `dash` (no answer about the name).
                          type: string
                          enum:
                            - tick
                            - warning
                            - cross
                            - dash
                        message:
                          description: >-
                            The result message to show the user, as supplied.
                            Show it as is.
                          type: string
                          minLength: 1
                        displayName:
                          description: >-
                            The registered name, when the receiving institution
                            permits it to be shown (for a PayID, the name it is
                            registered to).
                          type: string
                          minLength: 1
                        confirmed:
                          description: >-
                            True when `result` is `match` or `close_match`. An
                            unconfirmed check needs `acceptMismatch: true` to be
                            used on a payment route or beneficiary.
                          type: boolean
                        fee:
                          description: >-
                            The fee charged for this check, billed on your
                            monthly invoice.
                          type: object
                          properties:
                            amount:
                              description: >-
                                The fee charged for this check, as a decimal
                                string ("0.00" when no fee applies).
                              type: string
                              pattern: ^\d+(\.\d+)?$
                            currency:
                              type: string
                              enum:
                                - AUD
                          required:
                            - amount
                            - currency
                        createdAt:
                          description: When the check was run.
                          type: string
                          format: date-time
                      required:
                        - id
                        - type
                        - result
                        - message
                        - confirmed
                        - fee
                        - createdAt
                  hasMore:
                    type: boolean
                    description: Whether a further page exists after this one.
                  nextCursor:
                    type: string
                    nullable: true
                    description: >-
                      Opaque cursor to pass as `cursor` to fetch the next page,
                      or null at the end.
                required:
                  - data
                  - hasMore
                  - nextCursor
      security:
        - Bearer: []
        - ApiKey: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: Wayex API key
      description: 'Send the same Wayex API key as `Authorization: Bearer <key>`.'
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        A Wayex API key. Use a secret key (`sk_…`) — it works on every endpoint.
        Publishable keys (`pk_…`) are accepted only on a small set of read
        endpoints: `GET /v1/rates`, `GET /v1/activity`, `GET
        /v1/developer-fees`, `GET /v1/revenue`, and `GET /v1/reports/revenue`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.