Introduction
Overview and architecture of the Avvio Payouts API.
Partner payouts · API version 2026-08-21.1
Pay your customers in their local currency, straight from your funded balance.
Server to server, one API key, 32 endpoints. Your end users never onboard with us. The money leaves your balance, and the person receiving it is your counterparty, not ours.
Move a real payout before you write any code
The package ships a client, a CLI and an MCP server together, with zero runtime dependencies. The CLI is the fastest honest path from nothing to a payout that moved — no signup form, no playground, no code.
export AVVIO_API_KEY=avvio_test_…
export AVVIO_ORG_ID=cmsx…
npx -y @avvio/payments doctor # is the credential right?
npx -y @avvio/payments guide # the whole flow, as commandsdoctor names which of the four things is wrong — key, organization, base URL, or an account that cannot pay yet — because "it doesn't work" is otherwise four indistinguishable problems. Then guide prints this:
Nothing above touches a payment network while your key id starts avvio_test_.
The sandbox is deterministic — you choose the outcome
The last four digits of the beneficiary account number select what the payout does. Same input, same outcome, every time: a partner writing tests needs that, and a flaky sandbox teaches integrators to wrap correct code in retries. The trigger travels with the beneficiary rather than living in a header you have to remember on every call.
Seven triggers cover the rail failure, the slow settle, the post-settlement bank return, the compliance block, the expired quote, the wallet-funded payout, and the happy path. The full table is on Sandbox Overview →
0003 is the one to run before you go live. It completes and then fails — a receiving bank returning a settled payment days later is the case a ledger that treats completed as immutable gets wrong. The quickstart walks it through.
How to get access
- Create an organization at business.avvio.xyz.
- Issue credentials under Developers. A test credential works against the sandbox immediately; a live one is issued once your organization is verified.
- Complete KYB verification with company details and documents
- Give your engineering team the key id, the organization id, and
Quickstart.
You do not need to talk to anyone to try the sandbox. Nothing in it touches a payment network, and no real money can move.
Start here
From API key to a completed test payout in under 5 minutes.
Simulated execution rails, account suffixes, and deterministic triggers.
Balance model, sender of record, trust boundaries, and payout lifecycle.
One header. Key handling, read-only scopes, IP pinning and rotation.
Credential storage, scopes, source addresses, rotation, data protection, and what we do not do.
Safe retries, duplicate prevention, and timeout recovery semantics.
Runtime corridor discovery, required field validation, and recipient creation.
One-call instant and two-step quote-and-accept execution patterns.
Collect recipient bank details with zero banking data touch.
The 5-state lifecycle, failure codes, and post-settlement bank returns.
Standard Webhooks signing, six payout events, and retry delivery ladder.
Sequence-based event log polling, cursor pagination, and ledger sync.
Every error type, money movement state, retry safety, and rate limits.
19 commands for testing and operations.
33 methods with zero runtime dependencies.
20 tools for autonomous agent payout execution.
32 operations grouped by functional resource.
Updated 13 days ago