Overview
The Client Account API lets you manage Axiym accounts owned by your onboarded clients: view balances, deposit funds, convert currencies, and make withdrawals. Each client completes Axiym onboarding and has its own accounts and activity.
To manage Axiym accounts owned by your organization, use the Account API.
One client context per workflow
Each operation belongs to one client. Its Axiym accounts, address book, and activity remain separate from those of other clients. Resources from different clients cannot be combined.
The core model
The API is organized around six connected resources.
| Resource | What it represents |
|---|---|
| External account | A bank account or wallet whitelisted in the client’s address book for deposits or withdrawals. It must be ACTIVE before use. |
| Axiym account | A balance with Axiym in one currency, connected to a specific payment rail. |
| Deposit | An incoming payment from a whitelisted external account that credits an Axiym account. |
| Conversion pair | Permission to sell one currency and buy another over specified payment rails, in one direction. |
| Conversion | An exchange between two Axiym accounts in different currencies, using a permitted conversion pair. |
| Withdrawal | An outgoing payment from an Axiym account to a whitelisted external account. |
An Axiym account is the center of the balance model. Deposits increase its balance, withdrawals decrease it, and conversions move value between Axiym accounts.
A typical workflow
- Select an active client. Keep the workflow within that client’s accounts and address book.
- Whitelist an external account. Add a bank account or wallet to the
client’s address book. Axiym performs due diligence and compliance checks
before the account becomes
ACTIVE. Wait for activation before using it for deposits or withdrawals. - Find the Axiym accounts. Identify the account for each currency you plan to hold or move.
- Fund an Axiym account. Retrieve its deposit instructions and send funds from the whitelisted external account using the specified details.
- Wait for the deposit. Wait until the deposit completes and the Axiym account is credited.
- Convert funds if needed. Select a permitted conversion pair, create a conversion to lock the rate, and confirm it before the quote expires.
- Withdraw funds. Create and confirm a withdrawal to send funds to a whitelisted external account in the client’s address book, in the same currency.
- Reconcile activity. Use deposits, conversions, withdrawals, and account statements to reconcile the resulting balance movements.
Not every integration needs every step. For example, you can deposit and withdraw without converting when the incoming and outgoing currency is the same.
Where to continue
- Clients and onboarding
- Address book and external accounts
- Axiym accounts and balances
- Depositing funds
- Currency conversions
- Withdrawing funds
- Notifications and webhooks
- Terminology
When you understand the model, use the Integration guide to set up credentials and make your first sandbox requests.