Overview

The Account API lets you fund your Axiym accounts from your own bank accounts or wallets and withdraw funds back to them. A company or payout provider, for example, can use it to deposit funds from entries in its address book and move funds back to those entries. Deposits are sent outside the API using the deposit instructions of the receiving account. Creating a withdrawal prepares the instruction; an explicit confirmation begins execution.

The core resources

How a deposit works

1. Retrieve the deposit instructions of the Axiym account to fund.
2. Send the funds from an active address book entry using those details.
3. Process signed deposit.* events and fetch the deposit when state matters.
4. Reconcile the completed deposit with the posted account credit.

How a withdrawal works

1. Retrieve the Axiym account that will fund the withdrawal.
2. Select an active address book entry with the same currency and a compatible route.
3. Create the withdrawal once, using an idempotency key for retry safety. The response returns a withdrawalId in PENDING_CONFIRMATION status.
4. Review the returned source, destination, amounts, and fee, then confirm that withdrawalId with a separate idempotency key to begin execution.
5. Process signed events and fetch the current withdrawal when state matters.
6. 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.
• Read Depositing funds for deposit instructions and the deposit lifecycle.
• Read Withdrawal lifecycle for the creation and confirmation states.
• Follow Getting Started to implement the flow.