Axiym
Implementation Guides

Select an address book entry

View Markdown

Select an external bank account or wallet owned by your organization as the deposit source or withdrawal destination. Register missing entries through the Axiym Dashboard; address book registration is managed outside the Account API. The Account API exposes the resulting records as address book entries, each with a reusable destinationId; registering an entry does not move money.

Select an address book entry

Use GET /address-book to list the bank accounts and wallets available to your organization. Use GET /address-book/{destinationId} when you need the full bank or wallet details for one entry.

A new record can be PENDING_REVIEW while Axiym reviews it. Only ACTIVE entries can send deposits or be selected for withdrawals. Do not use an entry that is pending review, suspended, or closed.

Once active, send deposits from the entry using the deposit instructions of the receiving Axiym account, and supply the returned destinationId when creating a withdrawal.