Check a payee name
curl --request POST \
--url https://api.sandbox.rails.wayex.com/v1/payee-checks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"type": "bank_account",
"bsb": "<string>",
"accountNumber": "<string>",
"accountName": "<string>"
}
'import requests
url = "https://api.sandbox.rails.wayex.com/v1/payee-checks"
payload = {
"type": "bank_account",
"bsb": "<string>",
"accountNumber": "<string>",
"accountName": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'bank_account',
bsb: '<string>',
accountNumber: '<string>',
accountName: '<string>'
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'bank_account',
'bsb' => '<string>',
'accountNumber' => '<string>',
'accountName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.rails.wayex.com/v1/payee-checks"
payload := strings.NewReader("{\n \"type\": \"bank_account\",\n \"bsb\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.rails.wayex.com/v1/payee-checks")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"bank_account\",\n \"bsb\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\"\n}")
.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::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"bank_account\",\n \"bsb\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}Pay AUD
Check a payee name
Checks the name you hold for an AUD bank account against the name the receiving bank has registered (type: bank_account), or resolves a PayID to the name it is registered to (type: payid).
POST
/
v1
/
payee-checks
Check a payee name
curl --request POST \
--url https://api.sandbox.rails.wayex.com/v1/payee-checks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"type": "bank_account",
"bsb": "<string>",
"accountNumber": "<string>",
"accountName": "<string>"
}
'import requests
url = "https://api.sandbox.rails.wayex.com/v1/payee-checks"
payload = {
"type": "bank_account",
"bsb": "<string>",
"accountNumber": "<string>",
"accountName": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 'bank_account',
bsb: '<string>',
accountNumber: '<string>',
accountName: '<string>'
})
};
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 => "POST",
CURLOPT_POSTFIELDS => json_encode([
'type' => 'bank_account',
'bsb' => '<string>',
'accountNumber' => '<string>',
'accountName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.rails.wayex.com/v1/payee-checks"
payload := strings.NewReader("{\n \"type\": \"bank_account\",\n \"bsb\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sandbox.rails.wayex.com/v1/payee-checks")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"type\": \"bank_account\",\n \"bsb\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\"\n}")
.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::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": \"bank_account\",\n \"bsb\": \"<string>\",\n \"accountNumber\": \"<string>\",\n \"accountName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}What this endpoint does
Checks the name you hold for an AUD bank account against the name the receiving bank has registered (type: bank_account), or resolves a PayID to the name it is registered to (type: payid).
When to use it
Call it before you save an AUD payout destination, or use thepayeeCheck field on off-ramp route and Treasury beneficiary creation to run the check in the same request. Pass the returned id as payeeCheck.checkId there to reuse this check instead of paying for a second one.
Before you call
Use a secret API key withpayees:write. Confirmation of Payee must be enabled for your account by Wayex; otherwise the request is refused with 403 confirmation_of_payee_not_enabled. A name with fewer than two printable characters, or details that fail validation, are refused with 400 before anything is checked.
Money and balance effect
This moves no money. Each answered check — anyresult, including no_match and not_found — is billed per your fee schedule on your monthly invoice (default AUD 0.40 per check, plus GST if your account is charged GST); fee.amount is what this check was charged. Refused and failed checks (400, 403, 422 payee_details_invalid, 429 payee_check_limit_reached, 502, 503 payee_check_unavailable) are not billed.
States and completion
The check is complete when it is returned; there is no later update or webhook. A non-match is still an answer: branch onresult and confirmed (true for match and close_match), and show message as returned. For a PayID, displayName is the name it is registered to; the linked bank account is never returned.
Safe retries
Send a uniqueIdempotency-Key per check. If the response is lost, or you receive 502, retry the same payload with the same key: a retry returns the original check and never bills twice. A new key runs, and bills, a new check.
Read Confirm payee for the complete workflow.Authorizations
BearerApiKey
Headers
Body
application/json
- Option 1
- Option 2
Response
The check result.
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 
