> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rails.wayex.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the Treasury overview

> Returns the tenant account’s Treasury summary, including wallet balances, funding setup, and effective capabilities.

## 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 with `treasury: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 an `Idempotency-Key`.

Read [Treasury overview](/treasury/overview) for the complete workflow.


## OpenAPI

````yaml /api-reference/openapi.json get /v1/treasury
openapi: 3.0.0
info:
  title: Wayex API
  description: >-
    Wayex APIs for direct customer payment routes and isolated, prefunded
    Treasury accounts. Each API key is bound to one tenant account and its own
    wallet, settings, webhooks, and reporting.
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.sandbox.wayex.com
    description: Sandbox integration environment
security:
  - Bearer: []
  - ApiKey: []
tags:
  - name: Treasury
    description: >-
      Prefunded AUD and stablecoin wallets for one isolated tenant account.
      Fund, pay, convert, withdraw, track, and reconcile without selecting
      another account.
  - name: Customers
    description: >-
      Onboard end customers, run verification, and manage each customer's
      entitlements.
  - name: Payment routes
    description: >-
      Standing deposit instructions per customer. When a customer funds a route,
      Wayex auto-converts at the live rate and pays out/sends — no quote, no
      lock.
  - name: Transfers
    description: >-
      Read the conversion records produced when customers fund payment routes —
      the live activity feed and per-conversion lifecycle timeline.
  - name: Rates
    description: >-
      The live indicative AUD↔stablecoin rate right now — the all-in rate Wayex
      quotes. Indicative only; the binding price is struck when a route's funds
      land.
  - name: Revenue
    description: Your developer-fee revenue over time.
  - name: Invoices
    description: >-
      Your monthly invoices — Wayex platform fees due, net of your accrued
      developer-fee credit.
  - name: Webhooks
    description: Subscribe to HMAC-signed event webhooks and inspect deliveries.
  - name: API keys
    description: Create, list, and rotate API keys for programmatic access.
  - name: Fees
    description: >-
      Configure your developer fee — the markup withheld from each conversion
      and credited against your monthly invoice.
  - name: Invitations
    description: Accept a team invitation and activate your account.
paths:
  /v1/treasury:
    get:
      tags:
        - Treasury
      summary: Get the Treasury overview
      description: >-
        Returns the tenant account’s Treasury summary, including wallet
        balances, funding setup, and effective capabilities. Use it to
        initialise a Treasury dashboard or confirm the account is ready before
        beginning a workflow.
      operationId: TreasuryController2_overview_v1
      parameters: []
      responses:
        '200':
          description: Tenant balances, funding instructions, and effective capabilities.
          content:
            application/json:
              schema:
                type: object
                properties:
                  clientId:
                    type: string
                    minLength: 1
                  balances:
                    type: array
                    items:
                      type: object
                      properties:
                        clientId:
                          type: string
                          minLength: 1
                        asset:
                          type: string
                          enum:
                            - AUD
                            - USDC
                            - USDT
                        posted:
                          description: >-
                            Wallet-ledger balance: available plus reserved.
                            Pending inbound receipts are excluded.
                          type: string
                          pattern: ^\d+(\.\d+)?$
                        pending:
                          description: >-
                            Gross amount received for detected or confirming
                            inbound funding. Fees may not be final; this amount
                            is not posted, reserved or spendable.
                          type: string
                          pattern: ^\d+(\.\d+)?$
                        reserved:
                          description: >-
                            Posted wallet money durably reserved for accepted
                            operations or funding holds.
                          type: string
                          pattern: ^\d+(\.\d+)?$
                        available:
                          description: Posted wallet money currently available to spend.
                          type: string
                          pattern: ^\d+(\.\d+)?$
                        asOf:
                          type: string
                          format: date-time
                      required:
                        - clientId
                        - asset
                        - posted
                        - pending
                        - reserved
                        - available
                        - asOf
                  configurations:
                    type: array
                    items:
                      type: object
                      properties:
                        limits:
                          type: object
                          properties:
                            rules:
                              type: array
                              items:
                                type: object
                                properties:
                                  operation:
                                    type: string
                                    enum:
                                      - funding
                                      - payout
                                      - stable_withdrawal
                                      - conversion
                                  asset:
                                    type: string
                                    enum:
                                      - AUD
                                      - USDC
                                      - USDT
                                  perTransactionMinimum:
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                  perTransactionMaximum:
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                  dailyMaximum:
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                  maxCount:
                                    type: integer
                                    minimum: 0
                                    exclusiveMinimum: true
                                  windowSeconds:
                                    type: integer
                                    minimum: 0
                                    exclusiveMinimum: true
                                required:
                                  - operation
                                  - asset
                              default: []
                            beneficiaryDailyMaximum:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                            creditLimits:
                              type: array
                              items:
                                type: object
                                properties:
                                  asset:
                                    type: string
                                    enum:
                                      - AUD
                                      - USDC
                                      - USDT
                                  amount:
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                required:
                                  - asset
                                  - amount
                              default: []
                        capabilities:
                          type: object
                          properties:
                            fundingEnabled:
                              type: boolean
                              default: true
                            payoutsEnabled:
                              type: boolean
                              default: true
                            stableWithdrawalsEnabled:
                              type: boolean
                              default: true
                            conversionsEnabled:
                              type: boolean
                              default: true
                            audInboundRails:
                              type: array
                              items:
                                type: string
                                enum:
                                  - bsb_account
                              default:
                                - bsb_account
                            audOutboundRails:
                              type: array
                              items:
                                type: string
                                enum:
                                  - bsb_account
                              default:
                                - bsb_account
                            assetNetworks:
                              type: array
                              items:
                                type: object
                                properties:
                                  asset:
                                    type: string
                                    enum:
                                      - USDC
                                      - USDT
                                  network:
                                    type: string
                                    enum:
                                      - ethereum
                                      - base
                                      - arbitrum
                                      - optimism
                                      - polygon
                                      - bsc
                                      - avalanche
                                      - solana
                                      - tron
                                required:
                                  - asset
                                  - network
                              default: []
                        settlement:
                          type: object
                          properties:
                            mode:
                              type: string
                              enum:
                                - automatic
                                - manual_review
                              default: automatic
                            quoteTtlSeconds:
                              type: integer
                              minimum: 5
                              exclusiveMinimum: false
                              maximum: 3600
                              exclusiveMaximum: false
                              default: 30
                            maximumSlippageBps:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: false
                              maximum: 10000
                              exclusiveMaximum: false
                              default: 0
                        returns:
                          type: object
                          properties:
                            lossAllocation:
                              type: string
                              enum:
                                - client
                                - wayex
                              default: client
                            refundDeductedFee:
                              type: boolean
                              default: false
                            holdbackBps:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: false
                              maximum: 10000
                              exclusiveMaximum: false
                              default: 0
                            replenishment:
                              type: string
                              enum:
                                - required
                                - automatic_debit
                                - manual
                              default: required
                            retryLimit:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: false
                              maximum: 20
                              exclusiveMaximum: false
                              default: 3
                            timeoutSeconds:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              default: 300
                            staleEventSeconds:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              default: 900
                        accounting:
                          type: object
                          properties:
                            glMapping:
                              type: object
                              additionalProperties:
                                type: string
                                minLength: 1
                              default: {}
                            policyTemplate:
                              type: string
                              minLength: 1
                              default: standard
                            statementFrequency:
                              type: string
                              enum:
                                - daily
                                - weekly
                                - monthly
                              default: daily
                            notifyOnReturn:
                              type: boolean
                              default: true
                        recovery:
                          type: object
                          properties:
                            rtoMinutes:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              default: 60
                            rpoMinutes:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: false
                              default: 5
                            queueRecoveryMinutes:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              default: 15
                            reconciliationStaleMinutes:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              default: 30
                            accountingCloseHours:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              default: 24
                        id:
                          type: string
                          minLength: 1
                        clientId:
                          type: string
                          minLength: 1
                        version:
                          type: integer
                          minimum: 0
                          exclusiveMinimum: true
                        effectiveAt:
                          type: string
                          format: date-time
                        createdAt:
                          type: string
                          format: date-time
                        createdBy:
                          type: string
                          minLength: 1
                        reason:
                          type: string
                          minLength: 1
                          maxLength: 500
                        pricing:
                          type: object
                          properties:
                            fees:
                              type: array
                              items:
                                type: object
                                properties:
                                  operation:
                                    type: string
                                    enum:
                                      - funding
                                      - payout
                                      - stable_withdrawal
                                      - conversion
                                  asset:
                                    type: string
                                    enum:
                                      - AUD
                                      - USDC
                                      - USDT
                                  percentBps:
                                    type: integer
                                    minimum: 0
                                    exclusiveMinimum: false
                                    maximum: 10000
                                    exclusiveMaximum: false
                                    default: 0
                                  fixedAmount:
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                    default: '0'
                                  minimumAmount:
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                  maximumAmount:
                                    type: string
                                    pattern: ^\d+(\.\d+)?$
                                  treatment:
                                    type: string
                                    enum:
                                      - deduct
                                    default: deduct
                                required:
                                  - operation
                                  - asset
                              default: []
                        identity:
                          type: object
                          properties:
                            requireSumsubEvidence:
                              type: boolean
                              default: false
                            sumsubLevelName:
                              type: string
                              minLength: 1
                            evidenceMaxAgeSeconds:
                              type: integer
                              minimum: 0
                              exclusiveMinimum: true
                              default: 86400
                            manualReviewThreshold:
                              type: string
                              pattern: ^\d+(\.\d+)?$
                      required:
                        - limits
                        - capabilities
                        - settlement
                        - returns
                        - accounting
                        - recovery
                        - id
                        - clientId
                        - version
                        - effectiveAt
                        - createdAt
                        - createdBy
                        - reason
                        - pricing
                        - identity
                  fundingInstruments:
                    type: array
                    items:
                      oneOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            clientId:
                              type: string
                              minLength: 1
                            providerReference:
                              type: string
                              minLength: 1
                            status:
                              type: string
                              enum:
                                - active
                                - inactive
                            createdAt:
                              type: string
                              format: date-time
                            updatedAt:
                              type: string
                              format: date-time
                            deactivatedAt:
                              type: string
                              format: date-time
                            type:
                              type: string
                              enum:
                                - aud_account
                            asset:
                              type: string
                              enum:
                                - AUD
                            accountName:
                              type: string
                              minLength: 1
                            bsb:
                              type: string
                              pattern: ^\d{6}$
                            accountNumber:
                              type: string
                              pattern: ^\d{1,9}$
                          required:
                            - id
                            - clientId
                            - providerReference
                            - status
                            - createdAt
                            - updatedAt
                            - type
                            - asset
                            - accountName
                            - bsb
                            - accountNumber
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            clientId:
                              type: string
                              minLength: 1
                            providerReference:
                              type: string
                              minLength: 1
                            status:
                              type: string
                              enum:
                                - active
                                - inactive
                            createdAt:
                              type: string
                              format: date-time
                            updatedAt:
                              type: string
                              format: date-time
                            deactivatedAt:
                              type: string
                              format: date-time
                            type:
                              type: string
                              enum:
                                - stable_address
                            asset:
                              type: string
                              enum:
                                - USDC
                                - USDT
                            network:
                              type: string
                              enum:
                                - ethereum
                                - base
                                - arbitrum
                                - optimism
                                - polygon
                                - bsc
                                - avalanche
                                - solana
                                - tron
                            address:
                              type: string
                              minLength: 1
                            tag:
                              type: string
                              minLength: 1
                          required:
                            - id
                            - clientId
                            - providerReference
                            - status
                            - createdAt
                            - updatedAt
                            - type
                            - asset
                            - network
                            - address
                  fundingReceipts:
                    type: array
                    items:
                      oneOf:
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            clientId:
                              type: string
                              minLength: 1
                            fundingInstrumentId:
                              type: string
                              minLength: 1
                            status:
                              type: string
                              enum:
                                - detected
                                - confirming
                                - credited
                                - held
                                - returned
                            gross:
                              type: object
                              properties:
                                amount:
                                  type: string
                                  pattern: ^\d+(\.\d+)?$
                                currency:
                                  type: string
                                  enum:
                                    - AUD
                                    - USDC
                                    - USDT
                                network:
                                  type: string
                                  enum:
                                    - ethereum
                                    - base
                                    - arbitrum
                                    - optimism
                                    - polygon
                                    - bsc
                                    - avalanche
                                    - solana
                                    - tron
                              required:
                                - amount
                                - currency
                            inboundFee:
                              type: object
                              properties:
                                amount:
                                  type: string
                                  pattern: ^\d+(\.\d+)?$
                                currency:
                                  type: string
                                  enum:
                                    - AUD
                                    - USDC
                                    - USDT
                                network:
                                  type: string
                                  enum:
                                    - ethereum
                                    - base
                                    - arbitrum
                                    - optimism
                                    - polygon
                                    - bsc
                                    - avalanche
                                    - solana
                                    - tron
                              required:
                                - amount
                                - currency
                            netCredit:
                              type: object
                              properties:
                                amount:
                                  type: string
                                  pattern: ^\d+(\.\d+)?$
                                currency:
                                  type: string
                                  enum:
                                    - AUD
                                    - USDC
                                    - USDT
                                network:
                                  type: string
                                  enum:
                                    - ethereum
                                    - base
                                    - arbitrum
                                    - optimism
                                    - polygon
                                    - bsc
                                    - avalanche
                                    - solana
                                    - tron
                              required:
                                - amount
                                - currency
                            providerReference:
                              type: string
                              minLength: 1
                            externalReference:
                              type: string
                              minLength: 1
                            downstreamReference:
                              type: string
                              minLength: 1
                            movementId:
                              type: string
                              minLength: 1
                            reason:
                              type: string
                              minLength: 1
                            nextAction:
                              type: string
                              enum:
                                - none
                                - wait_for_confirmation
                                - contact_support
                            occurredAt:
                              type: string
                              format: date-time
                            creditedAt:
                              type: string
                              format: date-time
                            updatedAt:
                              type: string
                              format: date-time
                            type:
                              type: string
                              enum:
                                - aud_payin
                            asset:
                              type: string
                              enum:
                                - AUD
                          required:
                            - id
                            - clientId
                            - fundingInstrumentId
                            - status
                            - gross
                            - inboundFee
                            - netCredit
                            - providerReference
                            - nextAction
                            - occurredAt
                            - updatedAt
                            - type
                            - asset
                        - type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                            clientId:
                              type: string
                              minLength: 1
                            fundingInstrumentId:
                              type: string
                              minLength: 1
                            status:
                              type: string
                              enum:
                                - detected
                                - confirming
                                - credited
                                - held
                                - returned
                            gross:
                              type: object
                              properties:
                                amount:
                                  type: string
                                  pattern: ^\d+(\.\d+)?$
                                currency:
                                  type: string
                                  enum:
                                    - AUD
                                    - USDC
                                    - USDT
                                network:
                                  type: string
                                  enum:
                                    - ethereum
                                    - base
                                    - arbitrum
                                    - optimism
                                    - polygon
                                    - bsc
                                    - avalanche
                                    - solana
                                    - tron
                              required:
                                - amount
                                - currency
                            inboundFee:
                              type: object
                              properties:
                                amount:
                                  type: string
                                  pattern: ^\d+(\.\d+)?$
                                currency:
                                  type: string
                                  enum:
                                    - AUD
                                    - USDC
                                    - USDT
                                network:
                                  type: string
                                  enum:
                                    - ethereum
                                    - base
                                    - arbitrum
                                    - optimism
                                    - polygon
                                    - bsc
                                    - avalanche
                                    - solana
                                    - tron
                              required:
                                - amount
                                - currency
                            netCredit:
                              type: object
                              properties:
                                amount:
                                  type: string
                                  pattern: ^\d+(\.\d+)?$
                                currency:
                                  type: string
                                  enum:
                                    - AUD
                                    - USDC
                                    - USDT
                                network:
                                  type: string
                                  enum:
                                    - ethereum
                                    - base
                                    - arbitrum
                                    - optimism
                                    - polygon
                                    - bsc
                                    - avalanche
                                    - solana
                                    - tron
                              required:
                                - amount
                                - currency
                            providerReference:
                              type: string
                              minLength: 1
                            externalReference:
                              type: string
                              minLength: 1
                            downstreamReference:
                              type: string
                              minLength: 1
                            movementId:
                              type: string
                              minLength: 1
                            reason:
                              type: string
                              minLength: 1
                            nextAction:
                              type: string
                              enum:
                                - none
                                - wait_for_confirmation
                                - contact_support
                            occurredAt:
                              type: string
                              format: date-time
                            creditedAt:
                              type: string
                              format: date-time
                            updatedAt:
                              type: string
                              format: date-time
                            type:
                              type: string
                              enum:
                                - stable_deposit
                            asset:
                              type: string
                              enum:
                                - USDC
                                - USDT
                            network:
                              type: string
                              enum:
                                - ethereum
                                - base
                                - arbitrum
                                - optimism
                                - polygon
                                - bsc
                                - avalanche
                                - solana
                                - tron
                            transactionHash:
                              type: string
                              minLength: 1
                            finalityReached:
                              type: boolean
                          required:
                            - id
                            - clientId
                            - fundingInstrumentId
                            - status
                            - gross
                            - inboundFee
                            - netCredit
                            - providerReference
                            - nextAction
                            - occurredAt
                            - updatedAt
                            - type
                            - asset
                            - network
                            - finalityReached
                  cryptoDestinations:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        clientId:
                          type: string
                          minLength: 1
                        name:
                          type: string
                          minLength: 1
                          maxLength: 120
                        asset:
                          type: string
                          enum:
                            - USDC
                            - USDT
                        network:
                          type: string
                          enum:
                            - ethereum
                            - base
                            - arbitrum
                            - optimism
                            - polygon
                            - bsc
                            - avalanche
                            - solana
                            - tron
                        address:
                          type: string
                          minLength: 1
                        tag:
                          type: string
                          minLength: 1
                        externalReference:
                          type: string
                          minLength: 1
                        version:
                          type: integer
                          minimum: 0
                          exclusiveMinimum: true
                        validationStatus:
                          type: string
                          enum:
                            - validated
                        status:
                          type: string
                          enum:
                            - active
                            - inactive
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                        deactivatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - clientId
                        - name
                        - asset
                        - network
                        - address
                        - externalReference
                        - version
                        - validationStatus
                        - status
                        - createdAt
                        - updatedAt
                  recentMovements:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        clientId:
                          type: string
                          minLength: 1
                        asset:
                          type: string
                          enum:
                            - AUD
                            - USDC
                            - USDT
                        kind:
                          type: string
                          enum:
                            - funding_credited
                            - funding_returned
                            - admin_adjustment
                            - payout_reserved
                            - withdrawal_reserved
                            - conversion_reserved
                            - conversion_credited
                            - reservation_released
                            - reservation_captured
                            - late_execution_debited
                            - funding_hold_released
                            - payout_returned
                        availableDelta:
                          type: string
                          pattern: ^-?\d+(\.\d+)?$
                        reservedDelta:
                          type: string
                          pattern: ^-?\d+(\.\d+)?$
                        reference:
                          type: string
                          minLength: 1
                        reason:
                          type: string
                          minLength: 1
                        occurredAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - clientId
                        - asset
                        - kind
                        - availableDelta
                        - reservedDelta
                        - reference
                        - occurredAt
                  runtimeCapabilities:
                    type: array
                    items:
                      type: object
                      properties:
                        configurationId:
                          type: string
                          minLength: 1
                        assetNetworks:
                          type: array
                          items:
                            type: object
                            properties:
                              asset:
                                type: string
                                enum:
                                  - USDC
                                  - USDT
                              network:
                                type: string
                                enum:
                                  - ethereum
                                  - base
                                  - arbitrum
                                  - optimism
                                  - polygon
                                  - bsc
                                  - avalanche
                                  - solana
                                  - tron
                            required:
                              - asset
                              - network
                        audInboundRails:
                          type: array
                          items:
                            type: string
                            enum:
                              - bsb_account
                        audOutboundRails:
                          type: array
                          items:
                            type: string
                            enum:
                              - bsb_account
                      required:
                        - configurationId
                        - assetNetworks
                        - audInboundRails
                        - audOutboundRails
                required:
                  - clientId
                  - balances
                  - configurations
                  - fundingInstruments
                  - fundingReceipts
                  - cryptoDestinations
                  - recentMovements
                  - runtimeCapabilities
      security:
        - Bearer: []
        - ApiKey: []
components:
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: Wayex API key
      description: 'Send the same Wayex API key as `Authorization: Bearer <key>`.'
    ApiKey:
      type: apiKey
      in: header
      name: X-Api-Key
      description: A Wayex API key. Use a secret key for write operations.

````