# Axiym Account API

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

Use the Account API to manage your organization's Axiym accounts: view balances and statements, register external bank accounts and wallets, deposit funds, convert currencies, and make withdrawals. The access token identifies your organization and provides access to its API resources.

Subscribe to webhooks to receive notifications about account movements and changes to deposits, conversions, withdrawals, and registered external accounts.

## Downloads




OpenAPI contract

v0.1.0 · current

Explore the schema or generate a client for your integration.

[


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




Postman collection

v0.1.0 · current

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

[


Download collection](/postman/account-api/axiym_account_api_v0.1.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.1.0/auth/oauth/token/post)

OAuth 2.0 client credentials authentication.







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

Your Axiym accounts and balances.







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

External bank accounts and wallets registered in your address book for whitelisting as deposit sources and withdrawal destinations.







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

Incoming funds credited to your Axiym accounts.







[Conversions](/account-api/api-reference/0.1.0/conversions/listConversionPairs)

Currency conversions between your permitted Axiym accounts.







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

Outgoing funds from your Axiym accounts.







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

Webhook subscriptions and signing keys.