Accounts and destinations
Every deposit and withdrawal connects two different resources: an Axiym account and an address book entry.
Axiym account
The Axiym account is the balance that deposits credit and withdrawals are
funded from. Retrieve it before moving funds and confirm its status, currency,
and available balance. Its receiving details are served by
GET /accounts/{accountId}/deposit-instructions.
The returned balance is the current account balance. Use the deposit or
withdrawal resource to track processing and the account statement to reconcile
posted credits and debits.
| Status | Meaning |
|---|---|
ACTIVE | The account is available to receive deposits and fund withdrawals. |
SUSPENDED | The account is unavailable for new deposits and withdrawals. |
CLOSED | The account has been permanently closed and cannot be used. |
Address book entry
An address book entry is an external bank account or wallet address owned
by your organization. It is selected by destinationId.
Register and manage address book entries in the Axiym Dashboard. The
Account API can retrieve and use address book records, but cannot create or
change them. If a destination is missing, complete its registration in the
Dashboard. Only an ACTIVE entry can send a deposit or receive a
withdrawal; PENDING_REVIEW, SUSPENDED, and CLOSED entries cannot.
| Status | Meaning |
|---|---|
PENDING_REVIEW | Axiym is reviewing the entry. |
ACTIVE | The entry is available as a deposit source and withdrawal destination. |
SUSPENDED | The entry is unavailable for deposits and withdrawals. |
CLOSED | The entry has been permanently retired. |
Use destination.* events or retrieve the entry to observe status changes.
destination.closed signals that the entry is permanently retired and can
no longer send deposits or receive withdrawals.
Compatibility checks
Before creating a withdrawal, confirm that:
- both resources are active;
- the source account has enough available balance for the withdrawal amount;
- the destination supports the source account currency; and
- bank or blockchain routing details match the intended route.
Do not treat accountId and destinationId as interchangeable. One identifies
the Axiym balance; the other identifies the external recipient.
Account statements
Use the account statement as the ledger view of posted account activity. A
completed deposit produces a CREDIT entry with
relatedResourceType: DEPOSIT and the corresponding depositId as
relatedResourceId. A completed withdrawal produces a DEBIT entry with
relatedResourceType: WITHDRAWAL and the corresponding withdrawalId.
Use the deposit or withdrawal resource to track processing. Use the statement to confirm the posted movement and resulting running balance.