Getting Started
Use this guide to retrieve your Axiym accounts, register and select external destinations, create withdrawals, track outcomes, and reconcile account activity.
Before implementing, read Concepts & Workflows.
Recommended path
1. Prepare access
Complete Access Setup, obtain environment-specific OAuth credentials, and configure the shared authentication, header, and idempotency conventions.
2. Register and verify webhooks
Create a subscription, verify Ed25519 signatures, deduplicate deliveries by event ID, and fetch the relevant resource whenever authoritative state matters.
3. Register an external account and validate the sandbox flow
Register an owned bank account or wallet with Register an external account, then use Sandbox testing and the Quick Start to confirm account access, destination activation, withdrawal creation, event handling, and reconciliation.
4. Implement the operational workflow
Follow Create a withdrawal, Track a withdrawal, and Reconcile activity.
Production-readiness checklist
- Credentials are stored and rotated securely.
- Egress addresses are allowlisted for the correct environment.
- Only active, compatible accounts and destinations can be selected.
- Idempotency keys survive timeouts and process restarts.
- Webhook signatures are verified against the raw request body.
- Duplicate and out-of-order events are handled safely.
- Current state is recovered through list and get operations.
- Completed withdrawals are reconciled to account activity and external records.