Getting Started
Use this guide to retrieve your Axiym accounts, select registered external accounts, deposit funds, create and confirm withdrawals, track outcomes, and reconcile account activity.
Before implementing, read Concepts & Workflows.
Recommended path
1. Prepare access
Complete Access setup to obtain environment-specific OAuth credentials, then use the authentication reference and shared header conventions to configure your integration.
2. Register and verify webhooks
Create a subscription through the Webhook Subscriptions reference, verify Ed25519 signatures, deduplicate deliveries by event ID, and fetch the relevant resource whenever authoritative state matters.
3. Select an external account and validate the sandbox flow
Address book entries are registered outside the Account API. Retrieve the available records using Select an address book entry, then use Sandbox testing to confirm account access, destination status, withdrawal creation and confirmation, event handling, and reconciliation. Start with the Quickstart using provisioned sandbox accounts and destinations.
4. Implement the operational workflow
Follow Deposit funds, Create and confirm a withdrawal, Track a withdrawal, and Reconcile activity.
Fundamentals
Use these references for the conventions that apply across the integration:
- Authentication
- Common headers
- Idempotency
- Pagination and query parameters
- Error handling and retries
- Rate limits
- Data formats and constants
Production-readiness checklist
- Credentials are stored and rotated securely.
- Any required egress or network controls are confirmed for the correct environment.
- Only active, compatible accounts and destinations can be selected.
- Idempotency keys survive timeouts and process restarts.
- A created withdrawal is confirmed explicitly before the integration treats it as processing.
- 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 deposits and withdrawals are reconciled to account activity and external records.