XEROF

REST API reference, v1

XEROF API documentation

Integrate with XEROF's Swiss regulated digital asset infrastructure: authentication, balances, wallets, orders, deposits, transfers, fiat withdrawals and webhooks.

Base URL

https://online.xerof.ch/gateway/api/v1

Version

v1

Security

JWT + Authorization header

OpenAPI

3.0.0

Authentication

The API is authenticated with a JWT sent in the Authorization header. Credentials are issued per client and scoped to that client's account.

    01

    Request access

    API credentials are issued to onboarded clients on request. Contact the middle office and we provision credentials against your account.

    02

    Obtain a token

    Authenticate with your credentials to receive a signed JWT. Tokens are short lived and must be refreshed rather than cached indefinitely.

    03

    Call the API

    Send the token on every request as Authorization: Bearer <token>, over TLS, against the v1 base URL. Requests and responses are JSON.

Example request

GET https://online.xerof.ch/gateway/api/v1/balances
Authorization: Bearer <your-jwt>
Accept: application/json

Endpoints

The v1 surface is grouped by resource. Each group operates only on the assets and accounts held under your own client relationship.

Balances

Read the current balance of every asset held under your account, per currency and per wallet, for reconciliation against your own ledger.

Wallets

List your segregated wallets and their deposit addresses, per asset and per network, so you can present the correct address to a counterparty.

Orders

Create and track conversions between stablecoins, cryptoassets and fiat. Each order returns the executed rate and the XEROF fee as separate lines.

Deposits

Retrieve incoming on-chain and fiat deposits with their status, confirmations, references and the wallet or account they credited.

Transfers

Move assets on chain from your segregated wallet to a whitelisted address, and follow the transfer through to confirmation.

Fiat withdrawals

Instruct payouts in USD, EUR, CHF or GBP to your own or a third-party bank account over Fedwire, SWIFT, SEPA, CHAPS or FPS.

Webhooks

Subscribe to events so your systems are notified when a deposit lands, an order fills or a payout settles, instead of polling.

Conventions

  • All requests and responses are JSON over HTTPS. Unencrypted requests are rejected.
  • Amounts are returned as decimal strings to avoid floating point rounding in your ledger.
  • Every write request should carry your own idempotency reference so a retry cannot duplicate an order or a payout.
  • Rate limits and IP allowlisting are configured per client at the time credentials are issued.
  • Sandbox credentials are available for integration testing before you move to production.

Request API access and we issue credentials, the full OpenAPI specification and sandbox keys.

Talk to our teamOpen account