Changelog
The API is version 1, in every path as /v1. Within it, changes only add: new fields, new
operations, new values of a status. Read only the fields you need and treat a value you do not
recognise as one you do not handle yet. A change that would break an integration would come as
/v2, served beside v1.
The Go and TypeScript clients share version numbers for the API’s changes, such as
go get sotirea.com/sdk/[email protected] and npm install @sotirea/[email protected]; a fix to one client alone
has a version of its own. Each client’s own changelog, with its method names, ships with it.
Sanctions screening. See sanctions screening.
- Every address you pay is checked against OFAC’s sanctions list and Sotirea’s own blocked list,
before your payment rules. A payment to a listed address is refused
403withfields.rulesanctioned_addressorblocked_destination; a quote answersrefusedwith the same rule, and approving such an address is refused400. A payment waiting for approval whose address is listed meanwhile fails, and its money is released. - The address check answers
listed. - Balances carry
held: deposits from a listed address held for a compliance review, counted inavailableand never inspendable. Paying out of held money is refused withinsufficient_balance. deposit.receivedwebhooks carryheld.
Sweeps, and paused networks. See sweeps and paused networks.
- Sweeps: list them with how each last ran, price one, and with Manage sweeps propose a sweep, a change or a stop, and withdraw your own proposal. A person confirms; a key never does.
- Payments carry
purpose,paymentorsweep, and deposits carrysweep, in their webhooks too. - Balances, deposits, payments, vault addresses and gas pools carry
pausedwhile a network or token is not available.
Everything an integration does in the console, over the API.
- Networks, with each one’s coin, finality, recognised tokens and whether payments are open.
- Vaults per customer, by your own
reference; references on payments, answered in their webhooks and filterable;vault_referenceon deposits. - Quoting a payment, checking an address, and speeding up or cancelling a stuck payment.
- Webhooks, managed over the API, and resending a delivery.
- Payment rules and approved addresses; refreshing a vault; the audit trail.
Go client only: its import path is sotirea.com/sdk/go from this version, and nothing else
changed. Use v1.0.1 or later; the path v1.0.0 declared never resolved.
The first version: who a key is, vaults, balances, deposits, payments, gas pools and statements
as CSV; refusals with code, fields.rule and a request id; webhooks signed to the Standard
Webhooks specification.