Sotirea developer documentation
Sotirea keeps digital assets safe for your business and your customers, and gives your own software a way to see and move them. You open a vault for each customer and show them where to pay. Sotirea tells you when money arrives and when it is safe to count. When you pay out, your payment rules are checked first, the people who need to agree do, and every movement is written to a ledger you can reconcile against.
These pages are for the developers who connect a product to Sotirea: an app that lets customers hold and send stablecoins, a marketplace that pays its sellers, a treasury team that wants its own tools on top of its balances.
What you can do with the API
Section titled “What you can do with the API”- Accept deposits per customer. Open one vault per customer, named by your own id for them, and show them its address. Sotirea follows the network and tells you, by webhook or when you ask, what arrived and when it became final.
- Pay out. Ask what a payment would cost and whether your rules allow it, then send it with your own id as the key, so a retry never pays twice. Network fees come from a pool you top up, never from the amount you send.
- Gather money into one place. Sweeps move what arrives in your customers’ vaults into a vault of your own, under your rules.
- Keep your books. Balances, deposits and payments are always there to read. A statement for any period comes as a CSV whose opening balance plus its movements equals its closing balance.
A few words used throughout
Section titled “A few words used throughout”- Network: a blockchain, such as Ethereum or Base. Each one is its own ledger with its own
coin, and money on one network stays on that network. Sotirea names each by its
CAIP-2 id: Ethereum is
eip155:1, Base iseip155:8453. - Address: where money is sent on a network, like an account number. A vault has one address, and it is the same on every network Sotirea supports.
- Vault: a place your organisation holds money. You decide what a vault is for: one per customer, one for your treasury, one for each team that pays out.
- Final: for a short time after a payment appears on a network, the network could still drop it. Once it can no longer be undone, it is final. Sotirea shows money as arriving straight away, and counts it only once it is final.
- Test and Live: every Sotirea customer starts in Test, where every network is a test network and nothing is worth anything. Live, with real money, opens once Sotirea has reviewed your application. The same code runs in both: only the key changes.
Where to start
Section titled “Where to start”The API has two official clients, for Go (go get sotirea.com/sdk/go) and TypeScript
(npm install @sotirea/sdk). Both are generated from the same description as the API
reference, so they always match what the API serves. Any other language can call the API
directly: it is JSON over HTTPS with a bearer key.