Axiym

Axiym accounts and balances

View Markdown

An Axiym account holds funds with Axiym in one currency and is connected to one payment rail.

For example, a client might have:

AccountCurrencyPayment railPurpose
USD Axiym accountUSDBank railHold USD received by Axiym, sell USD in permitted conversions, and fund USD withdrawals.
USDT Axiym accountUSDTBlockchain networkHold USDT received by Axiym, sell USDT in permitted conversions, and fund USDT withdrawals.

Each Axiym account has a unique accountId. Its deposit instructions and statements describe funding and activity for that account.

Axiym accounts and external accounts

These resources serve different roles and their identifiers are not interchangeable.

Axiym accountExternal account
Where it existsWith AxiymAt an external bank or on a blockchain network
What it representsA balance held with AxiymA bank account or wallet whitelisted in the client’s address book
IdentifieraccountIddestinationId
In a depositReceives the resulting account creditMust be the origin of the incoming payment
In a withdrawalSupplies the balance through sourceAccountIdReceives the outgoing payment through destinationId

Deposit instructions tell you where to send funds to credit an Axiym account. The external account sending the funds must be whitelisted and ACTIVE in the selected client’s address book.

What an account tells you

An account contains:

FieldMeaning
accountIdThe stable identifier for the balance held with Axiym.
currencyThe currency held by the account.
paymentRailsThe bank rail or blockchain network on which the account settles.
balanceThe amount currently available in the account's currency.
statusWhether the account is active, suspended, or closed.

How balances change

Posted ledger movements include:

  • a completed deposit credits an account;
  • a posted withdrawal debit reduces an account's balance;
  • a completed conversion debits its sellAccount and credits its buyAccount; or
  • an operational adjustment posts directly to the ledger.

Use balance for the amount currently available and the account statement for posted movements. Reserved funds can make the available balance differ from the statement balance.

Account statements

An account statement provides opening and closing balances, totals for credits and debits, and the individual ledger entries for a period.

The totals reconcile as follows:

opening balance + total credited - total debited = closing balance

Each entry has a direction (CREDIT or DEBIT), a positive amount, and the balance after the movement. When the entry relates to a deposit, conversion, or withdrawal, it also contains the type and identifier of that resource.

This lets you move from a balance difference to the business operation that caused it.

Account status

StatusMeaning
ACTIVEThe account is available for permitted operations.
SUSPENDEDUse of the account is temporarily restricted.
CLOSEDThe account has been permanently retired.

Do not assume that having an account grants access to every currency conversion. The available directions are defined separately by conversion pairs.

For amount formats and precision handling, see Data formats and constants. For implementation steps, see Reconcile activity.