Get Treasury funding instructions
curl --request GET \
--url https://api.sandbox.rails.wayex.com/v1/treasury/funding-instruments/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.rails.wayex.com/v1/treasury/funding-instruments/{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/treasury/funding-instruments/{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/treasury/funding-instruments/{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/treasury/funding-instruments/{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/treasury/funding-instruments/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.rails.wayex.com/v1/treasury/funding-instruments/{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>",
"clientId": "<string>",
"providerReference": "<string>",
"status": "active",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "aud_account",
"asset": "AUD",
"accountName": "<string>",
"bsb": "<string>",
"accountNumber": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z",
"payId": "<string>",
"activationMessage": "<string>"
}Treasury resource management
Get Treasury funding instructions
Returns one reusable AUD or stablecoin funding instrument owned by this tenant account. An AUD instrument shows its BSB and account number and any issued payId.
GET
/
v1
/
treasury
/
funding-instruments
/
{id}
Get Treasury funding instructions
curl --request GET \
--url https://api.sandbox.rails.wayex.com/v1/treasury/funding-instruments/{id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.rails.wayex.com/v1/treasury/funding-instruments/{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/treasury/funding-instruments/{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/treasury/funding-instruments/{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/treasury/funding-instruments/{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/treasury/funding-instruments/{id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.rails.wayex.com/v1/treasury/funding-instruments/{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>",
"clientId": "<string>",
"providerReference": "<string>",
"status": "active",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "aud_account",
"asset": "AUD",
"accountName": "<string>",
"bsb": "<string>",
"accountNumber": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z",
"payId": "<string>",
"activationMessage": "<string>"
}What this endpoint does
Returns one reusable AUD or stablecoin funding instrument owned by this tenant account. An AUD instrument shows its BSB and account number and any issuedpayId.
When to use it
Use it to display the exact current instructions or inspect an instrument followed from an incoming pay-in or deposit.Before you call
Authenticate withtreasury:read and pass a funding-instrument 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
An active instrument can receive funds. A newly issued AUD account or PayID can take a few minutes to activate for NPP; honour anyactivationMessage before relying on the PayID. An inactive instrument remains readable for history but must not be shared for new funding.
Safe retries
GET requests are read-only and may be retried with normal exponential backoff. Do not send anIdempotency-Key.
Read Funding and balances for the complete workflow.Authorizations
BearerApiKey
Send the same Wayex API key as Authorization: Bearer <key>.
Path Parameters
Response
200 - application/json
- Option 1
- Option 2
- Option 3
Minimum string length:
1Minimum string length:
1Minimum string length:
1Available options:
active, inactive Available options:
aud_account Available options:
AUD Minimum string length:
1Pattern:
^\d{6}$Pattern:
^\d{1,9}$Minimum string length:
1Minimum string length:
1
