Axiym Client Account API
Use the Client Account API to manage Axiym accounts owned by clients onboarded through your partnership: view balances and statements, register external bank accounts and wallets, deposit funds, convert currencies, and make withdrawals. The access token identifies your partnership; clientId selects the client whose API resources you operate.
Subscribe to webhooks to receive notifications about client availability, account movements, and changes to deposits, conversions, withdrawals, and registered external accounts. Subscriptions belong to your partnership. Events about client resources include clientId to identify the relevant client.
Downloads
OpenAPI contract
v0.3.0 · currentExplore the schema or generate a client for your integration.
Download OpenAPIPostman collection
v0.3.0 · currentImport ready-to-use requests and connect to the sandbox.
Download collectionEnvironments
Resources
Auth
OAuth 2.0 client credentials authentication for the partnership.
Onboarding
Client KYB onboarding applications and their review status.
Clients
Client records associated with your partnership. The list includes clients that are onboarding, active, or disabled; only active clients can use Client Account API operations.
Accounts
Axiym accounts and balances owned by the represented client.
Address Book
External bank accounts and wallets registered in the selected client's address book for whitelisting as deposit sources and withdrawal destinations.
Deposits
Incoming funds credited to the represented client’s Axiym accounts.
Conversions
Currency conversions between the represented client’s permitted Axiym accounts.
Withdrawals
Outgoing funds from the represented client’s Axiym accounts.
Webhook Subscriptions
Partnership-owned webhook subscriptions and signing keys.