Get the Treasury overview
curl --request GET \
--url https://api.sandbox.wayex.com/v1/treasury \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.wayex.com/v1/treasury"
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.wayex.com/v1/treasury', 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.wayex.com/v1/treasury",
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.wayex.com/v1/treasury"
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.wayex.com/v1/treasury")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.wayex.com/v1/treasury")
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{
"clientId": "<string>",
"balances": [
{
"clientId": "<string>",
"posted": "<string>",
"pending": "<string>",
"reserved": "<string>",
"available": "<string>",
"asOf": "2023-11-07T05:31:56Z"
}
],
"configurations": [
{
"limits": {
"rules": [],
"beneficiaryDailyMaximum": 1,
"creditLimits": []
},
"capabilities": {
"fundingEnabled": true,
"payoutsEnabled": true,
"stableWithdrawalsEnabled": true,
"conversionsEnabled": true,
"audInboundRails": [
"bsb_account"
],
"audOutboundRails": [
"bsb_account"
],
"assetNetworks": []
},
"settlement": {
"mode": "automatic",
"quoteTtlSeconds": 30,
"maximumSlippageBps": 0
},
"returns": {
"lossAllocation": "client",
"refundDeductedFee": false,
"holdbackBps": 0,
"replenishment": "required",
"retryLimit": 3,
"timeoutSeconds": 300,
"staleEventSeconds": 900
},
"accounting": {
"glMapping": {},
"policyTemplate": "standard",
"statementFrequency": "daily",
"notifyOnReturn": true
},
"recovery": {
"rtoMinutes": 60,
"rpoMinutes": 5,
"queueRecoveryMinutes": 15,
"reconciliationStaleMinutes": 30,
"accountingCloseHours": 24
},
"id": "<string>",
"clientId": "<string>",
"version": 1,
"effectiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"reason": "<string>",
"pricing": {
"fees": []
},
"identity": {
"requireSumsubEvidence": false,
"sumsubLevelName": "<string>",
"evidenceMaxAgeSeconds": 86400,
"manualReviewThreshold": "<string>"
}
}
],
"fundingInstruments": [
{
"id": "<string>",
"clientId": "<string>",
"providerReference": "<string>",
"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"
}
],
"fundingReceipts": [
{
"id": "<string>",
"clientId": "<string>",
"fundingInstrumentId": "<string>",
"gross": {
"amount": "<string>"
},
"inboundFee": {
"amount": "<string>"
},
"netCredit": {
"amount": "<string>"
},
"providerReference": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "aud_payin",
"asset": "AUD",
"externalReference": "<string>",
"downstreamReference": "<string>",
"movementId": "<string>",
"reason": "<string>",
"creditedAt": "2023-11-07T05:31:56Z"
}
],
"cryptoDestinations": [
{
"id": "<string>",
"clientId": "<string>",
"name": "<string>",
"address": "<string>",
"externalReference": "<string>",
"version": 1,
"validationStatus": "validated",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"tag": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
],
"recentMovements": [
{
"id": "<string>",
"clientId": "<string>",
"availableDelta": "<string>",
"reservedDelta": "<string>",
"reference": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"runtimeCapabilities": [
{
"configurationId": "<string>",
"assetNetworks": [
{}
],
"audInboundRails": [
"bsb_account"
],
"audOutboundRails": [
"bsb_account"
]
}
]
}Fund and check balance
Get the Treasury overview
Returns the tenant account’s Treasury summary, including wallet balances, funding setup, and effective capabilities.
GET
/
v1
/
treasury
Get the Treasury overview
curl --request GET \
--url https://api.sandbox.wayex.com/v1/treasury \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.sandbox.wayex.com/v1/treasury"
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.wayex.com/v1/treasury', 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.wayex.com/v1/treasury",
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.wayex.com/v1/treasury"
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.wayex.com/v1/treasury")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.wayex.com/v1/treasury")
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{
"clientId": "<string>",
"balances": [
{
"clientId": "<string>",
"posted": "<string>",
"pending": "<string>",
"reserved": "<string>",
"available": "<string>",
"asOf": "2023-11-07T05:31:56Z"
}
],
"configurations": [
{
"limits": {
"rules": [],
"beneficiaryDailyMaximum": 1,
"creditLimits": []
},
"capabilities": {
"fundingEnabled": true,
"payoutsEnabled": true,
"stableWithdrawalsEnabled": true,
"conversionsEnabled": true,
"audInboundRails": [
"bsb_account"
],
"audOutboundRails": [
"bsb_account"
],
"assetNetworks": []
},
"settlement": {
"mode": "automatic",
"quoteTtlSeconds": 30,
"maximumSlippageBps": 0
},
"returns": {
"lossAllocation": "client",
"refundDeductedFee": false,
"holdbackBps": 0,
"replenishment": "required",
"retryLimit": 3,
"timeoutSeconds": 300,
"staleEventSeconds": 900
},
"accounting": {
"glMapping": {},
"policyTemplate": "standard",
"statementFrequency": "daily",
"notifyOnReturn": true
},
"recovery": {
"rtoMinutes": 60,
"rpoMinutes": 5,
"queueRecoveryMinutes": 15,
"reconciliationStaleMinutes": 30,
"accountingCloseHours": 24
},
"id": "<string>",
"clientId": "<string>",
"version": 1,
"effectiveAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"reason": "<string>",
"pricing": {
"fees": []
},
"identity": {
"requireSumsubEvidence": false,
"sumsubLevelName": "<string>",
"evidenceMaxAgeSeconds": 86400,
"manualReviewThreshold": "<string>"
}
}
],
"fundingInstruments": [
{
"id": "<string>",
"clientId": "<string>",
"providerReference": "<string>",
"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"
}
],
"fundingReceipts": [
{
"id": "<string>",
"clientId": "<string>",
"fundingInstrumentId": "<string>",
"gross": {
"amount": "<string>"
},
"inboundFee": {
"amount": "<string>"
},
"netCredit": {
"amount": "<string>"
},
"providerReference": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"type": "aud_payin",
"asset": "AUD",
"externalReference": "<string>",
"downstreamReference": "<string>",
"movementId": "<string>",
"reason": "<string>",
"creditedAt": "2023-11-07T05:31:56Z"
}
],
"cryptoDestinations": [
{
"id": "<string>",
"clientId": "<string>",
"name": "<string>",
"address": "<string>",
"externalReference": "<string>",
"version": 1,
"validationStatus": "validated",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"tag": "<string>",
"deactivatedAt": "2023-11-07T05:31:56Z"
}
],
"recentMovements": [
{
"id": "<string>",
"clientId": "<string>",
"availableDelta": "<string>",
"reservedDelta": "<string>",
"reference": "<string>",
"occurredAt": "2023-11-07T05:31:56Z",
"reason": "<string>"
}
],
"runtimeCapabilities": [
{
"configurationId": "<string>",
"assetNetworks": [
{}
],
"audInboundRails": [
"bsb_account"
],
"audOutboundRails": [
"bsb_account"
]
}
]
}What this endpoint does
Returns the tenant account’s Treasury summary, including wallet balances, funding setup, and effective capabilities.When to use it
Use it to initialise a Treasury dashboard or confirm the account is ready before beginning a workflow.Before you call
Authenticate withtreasury:read. The API key is bound to one tenant account and cannot select or read another account.
Money and balance effect
This is a read-only request. It does not reserve, debit, credit, or settle money.States and completion
Treat balance timestamps and capability flags as point-in-time values. Read the specific resource before acting on changing state.Safe retries
GET requests are read-only and may be retried with normal exponential backoff. Do not send anIdempotency-Key.
Read Treasury overview for the complete workflow.Authorizations
BearerApiKey
Send the same Wayex API key as Authorization: Bearer <key>.
Response
200 - application/json
Tenant balances, funding instructions, and effective capabilities.
Minimum string length:
1Show child attributes
Show child attributes
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I

