Get a payment route
curl --request GET \
--url https://api.sandbox.rails.wayex.com/v1/payment-routes/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.rails.wayex.com/v1/payment-routes/{id}"
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/payment-routes/{id}', 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/payment-routes/{id}",
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/payment-routes/{id}"
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/payment-routes/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.rails.wayex.com/v1/payment-routes/{id}")
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{
"id": "<string>",
"counterpartyId": "<string>",
"customerId": "<string>",
"direction": "aud_to_stablecoin",
"destination": {
"network": "ethereum",
"address": "<string>",
"currency": "USDC"
},
"status": "active",
"instructions": {
"title": "<string>",
"reference": "<string>",
"deposit": {
"kind": "aud",
"bsb": "<string>",
"accountNumber": "<string>",
"reference": "<string>",
"payId": {
"type": "email",
"value": "<string>"
}
},
"destinationSummary": "<string>",
"steps": [
"<string>"
],
"limits": {
"min": "<string>",
"max": "<string>",
"daily": "<string>"
}
},
"createdAt": "2023-11-07T05:31:56Z",
"limits": {
"min": "<string>",
"max": "<string>",
"daily": "<string>"
}
}Direct-route records
Get a payment route
Returns configuration and current status for one standing payment route.
GET
/
v1
/
payment-routes
/
{id}
Get a payment route
curl --request GET \
--url https://api.sandbox.rails.wayex.com/v1/payment-routes/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.rails.wayex.com/v1/payment-routes/{id}"
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/payment-routes/{id}', 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/payment-routes/{id}",
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/payment-routes/{id}"
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/payment-routes/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.rails.wayex.com/v1/payment-routes/{id}")
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{
"id": "<string>",
"counterpartyId": "<string>",
"customerId": "<string>",
"direction": "aud_to_stablecoin",
"destination": {
"network": "ethereum",
"address": "<string>",
"currency": "USDC"
},
"status": "active",
"instructions": {
"title": "<string>",
"reference": "<string>",
"deposit": {
"kind": "aud",
"bsb": "<string>",
"accountNumber": "<string>",
"reference": "<string>",
"payId": {
"type": "email",
"value": "<string>"
}
},
"destinationSummary": "<string>",
"steps": [
"<string>"
],
"limits": {
"min": "<string>",
"max": "<string>",
"daily": "<string>"
}
},
"createdAt": "2023-11-07T05:31:56Z",
"limits": {
"min": "<string>",
"max": "<string>",
"daily": "<string>"
}
}What this endpoint does
Returns configuration and current status for one standing payment route.When to use it
Use it to display route detail, validate its state, or follow a route reference from a transfer.Before you call
Authenticate with route read access and pass a route ID owned by the same tenant account.Money and balance effect
This is a read-only request. It does not reserve, debit, credit, or settle money.States and completion
The route status does not describe an individual funding. Read the linked transfer for conversion and settlement state.Safe retries
GET requests are read-only and may be retried with normal exponential backoff. Do not send anIdempotency-Key.
Read Payment routes for the complete workflow.Authorizations
BearerApiKey
Send the same Wayex API key as Authorization: Bearer <key>.
Path Parameters
Response
The payment route.
- Option 1
- Option 2
Minimum string length:
1The client account (counterparty) this route belongs to. For API callers this is always your own account id.
Minimum string length:
1Minimum string length:
1Available options:
aud_to_stablecoin Show child attributes
Show child attributes
Available options:
active, inactive Show child attributes
Show child attributes
Show child attributes
Show child attributes

