# Axiym Account API

Product: Account API
API reference version: 0.3.0 (current)
OpenAPI contract: https://docs.axiym.io/openapi/account-api/0.3.0.yaml
Canonical page: https://docs.axiym.io/account-api/api-reference/0.3.0

Use the Account API to view Axiym accounts, registered address book entries, and account activity; retrieve deposit instructions and track deposits; create and confirm withdrawals; and receive webhook notifications. The access token identifies the organization that owns every account, address book entry, deposit, withdrawal, and webhook subscription.

## Deposit flow

1. Retrieve the receiving details with `GET /accounts/{accountId}/deposit-instructions`.
2. Send the funds from an `ACTIVE` address book entry using those details.
3. Track the incoming payment with `GET /deposits` and `GET /deposits/{depositId}` or deposit webhooks.

## Withdrawal flow

1. Select an `ACTIVE` source account and an `ACTIVE` address book entry in the same currency.
2. Create the withdrawal with `POST /withdrawals`. The response returns its `withdrawalId` in `PENDING_CONFIRMATION` status.
3. Confirm that identifier with `POST /withdrawals/{withdrawalId}/confirm` to begin execution.
4. Track the outcome with `GET /withdrawals/{withdrawalId}` or withdrawal webhooks.

## Downloads




OpenAPI contract

v0.3.0 · current

Explore the schema or generate a client for your integration.

[


Download OpenAPI](/openapi/account-api/0.3.0.yaml)




Postman collection

v0.3.0 · current

Import ready-to-use requests and connect to the sandbox.

[


Download collection](/postman/account-api/axiym_account_api_v0.3.0.json)

## Environments




Sandbox

[`https://partner-api.sandbox.axiym.io/api/v1`](https://partner-api.sandbox.axiym.io/api/v1)




Production

[`https://partner-api.axiym.io/api/v1`](https://partner-api.axiym.io/api/v1)

## Resources



[Auth](/account-api/api-reference/0.3.0/auth/oauth/token/post)

OAuth 2.0 client credentials authentication.







[Accounts](/account-api/api-reference/0.3.0/accounts/listAccounts)

Axiym accounts, balances, and posted ledger activity.







[Address Book](/account-api/api-reference/0.3.0/address-book/listAddressBookEntries)

Registered external bank accounts and wallet addresses you own — the permitted deposit sources and withdrawal destinations.







[Deposits](/account-api/api-reference/0.3.0/deposits/getDepositInstructions)

Incoming funds credited to your Axiym accounts.







[Withdrawals](/account-api/api-reference/0.3.0/withdrawals/listWithdrawals)

Outgoing payments from Axiym accounts to registered address book entries.







[Webhook Subscriptions](/account-api/api-reference/0.3.0/webhook-subscriptions/webhooks/subscriptions/get)

Webhook subscription management and webhook public keys.