List payee checks
curl --request GET \
--url https://api.sandbox.rails.wayex.com/v1/payee-checks \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.rails.wayex.com/v1/payee-checks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.rails.wayex.com/v1/payee-checks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.rails.wayex.com/v1/payee-checks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.rails.wayex.com/v1/payee-checks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.rails.wayex.com/v1/payee-checks")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.rails.wayex.com/v1/payee-checks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"type": "bank_account",
"result": "match",
"message": "<string>",
"confirmed": true,
"fee": {
"amount": "<string>",
"currency": "AUD"
},
"createdAt": "2023-11-07T05:31:56Z",
"bankAccount": {
"bsb": "<string>",
"accountNumber": "<string>",
"accountName": "<string>"
},
"payId": {
"type": "email",
"value": "<string>"
},
"indicator": "tick",
"displayName": "<string>"
}
],
"hasMore": true,
"nextCursor": "<string>"
}Pay AUD
List payee checks
Lists the payee checks run for this tenant account, newest first.
GET
/
v1
/
payee-checks
List payee checks
curl --request GET \
--url https://api.sandbox.rails.wayex.com/v1/payee-checks \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.rails.wayex.com/v1/payee-checks"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.sandbox.rails.wayex.com/v1/payee-checks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sandbox.rails.wayex.com/v1/payee-checks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.rails.wayex.com/v1/payee-checks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.sandbox.rails.wayex.com/v1/payee-checks")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.rails.wayex.com/v1/payee-checks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"type": "bank_account",
"result": "match",
"message": "<string>",
"confirmed": true,
"fee": {
"amount": "<string>",
"currency": "AUD"
},
"createdAt": "2023-11-07T05:31:56Z",
"bankAccount": {
"bsb": "<string>",
"accountNumber": "<string>",
"accountName": "<string>"
},
"payId": {
"type": "email",
"value": "<string>"
},
"indicator": "tick",
"displayName": "<string>"
}
],
"hasMore": true,
"nextCursor": "<string>"
}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 aspayeeCheck.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 includepayees: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 anIdempotency-Key.
Read Confirm payee for the complete workflow.Authorizations
BearerApiKey
Response
200 - application/json
A cursor-paginated page of payee checks.

