API reference

Submitting

Submit signed transfers and request test USD₮.

Submit a transfer

POST/tx
Request body
{
  "from": "0x1323a980c3e4736108741dacdad57d08e60bd827",
  "to": "0x38496f6877382de8255668ae407f4c0ea2acc0f7",
  "amount": "12.5",
  "fee": "0.01",
  "nonce": 0,
  "memo": "Hello from the docs",
  "sig": "0x2c96fda2…1ca36b3b0b1c"
}
FieldRequiredMeaning
fromYesSender address
toYesRecipient address
amountYesDecimal USD₮ string, as signed
feeNoDefaults to "0.01", the only accepted value
nonceYesSender's current nonce, an integer
memoNoUp to 140 characters, as signed
sigYesEIP-191 signature of the transfer message

Returns 201 with the transfer, usually already final. The network seals a block as soon as a transfer is accepted. If the transfer fails when it is sealed, for example because another transfer spent the balance first, it is returned with "status": "failed" and an error.

Request test USD₮

POST/faucet
Request body
{ "address": "0x…" }

Mints 100 test USD₮ to the address as a mint from the issuer, and returns the mint with 201. Limited to once per address every 24 hours and once per IP address per minute. Testnet only.

Bridge deposit (testnet)

POST/bridge/deposit/quote
Request body
{ "from": "<your Solana address>", "to": "0x… (USD Network)", "amount": "25" }

For Solana devnet, this returns the exact transfer to sign, params, with the vault as fee payer and the memo usdnet:<to>, plus a token. The transaction is built with the shared builder in @usd/solana. For Base Sepolia, send { "chain": "base-sepolia", "from": "0x…", "amount": "25" }. You get back params for an EIP-3009 TransferWithAuthorization to the vault (domain USDC, version 2, chain 84532), and the vault submits it and pays the gas.

POST/bridge/deposit/send
Request body
{ "params": { … }, "token": "…", "sig": "<owner signature, base64>" }

The vault adds its signature as fee payer, simulates the transaction and sends it. The deposit is then credited at once. Withdrawals need no special endpoint: they are a normal signed transfer to the bridge address with the memo out:solana-devnet:<address> or out:base-sepolia:<0x address>. GET /bridge/out/<transfer hash> returns the release state: queued, waiting, released (with the Solana signature) or unconfirmed. POST /bridge/check with { "signature": "…" }, or { "chain": "base-sepolia", "hash": "0x…" }, asks the bridge to read a deposit right away.