Skip to main content
GET
Get a payee check

What this endpoint does

Returns one payee check: the details checked, the result, the message and the fee.

When to use it

Use it to show a check again, or to confirm a check before reusing it as payeeCheck.checkId.

Before you call

Authenticate with payees:read and pass a check ID owned by the same tenant account. An unknown ID returns 404 payee_check_not_found.

Money and balance effect

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

States and completion

A check never changes after it is created. Reading it costs nothing and never re-runs it.

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>.

Path Parameters

id
string
required

Response

id
string
required

The payee check id (pchk_ + 32 hex characters).

Pattern: ^pchk_[0-9a-f]{32}$
type
enum<string>
required

What is checked: an AUD bank account (BSB + account number + name) or a PayID.

Available options:
bank_account,
payid
result
enum<string>
required

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.

Available options:
match,
close_match,
no_match,
not_found,
closed
message
string
required

The result message to show the user, as supplied. Show it as is.

Minimum string length: 1
confirmed
boolean
required

True when result is match or close_match. An unconfirmed check needs acceptMismatch: true to be used on a payment route or beneficiary.

fee
object
required

The fee charged for this check, billed on your monthly invoice.

createdAt
string<date-time>
required

When the check was run.

bankAccount
object

The bank account checked. Present when type is bank_account.

payId
object

The PayID resolved. Present when type is payid.

indicator
enum<string>

The icon to show with the result: tick (confirmed), warning (close match), cross (not confirmed) or dash (no answer about the name).

Available options:
tick,
warning,
cross,
dash
displayName
string

The registered name, when the receiving institution permits it to be shown (for a PayID, the name it is registered to).

Minimum string length: 1