Overview
The Account API lets you withdraw your own funds from Axiym accounts to approved bank accounts or wallet addresses. A company or payout provider, for example, can use it to move its own funds to registered external accounts.
The core resources
Axiym account
The balance from which the withdrawal amount and applicable fee are funded.
Whitelisted own account
An external bank account or wallet address owned by your organization and approved by Axiym.
Withdrawal
The instruction and lifecycle record for moving funds from an Axiym account to an approved destination.
Event
A signed notification about withdrawals, account movements, destinations, or a subscription test.
How a withdrawal works
- Retrieve the Axiym account that will fund the withdrawal.
- Select an active whitelisted own account with compatible currency and route.
- Create the withdrawal once, using an idempotency key for retry safety.
- Process signed events and fetch the current withdrawal when state matters.
- Reconcile the withdrawal with account activity and the receiving bank or blockchain record.
Where to go next
- Read Accounts and destinations before building destination selection.
- Follow Getting Started to implement the flow.