Axiym Client Trade API
Use the Client Trade API to manage balances and move funds on behalf of clients onboarded through your partnership. The partner access token identifies the partnership, and clientId identifies the client that owns each account, address book entry, deposit, conversion, and withdrawal.
Webhook subscriptions are partnership-owned and deliver events for client-owned resources. Use the event clientId to route each event to the correct client context.
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 Trade API operations.
Accounts
Axiym accounts and balances owned by the represented client.
Address Book
External bank accounts and wallets owned by the represented client, registered as deposit sources and withdrawal recipients.
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.