Axiym Client Account API Events
This reference describes the webhook events Axiym sends to your registered HTTPS endpoint for Client Account API activity. Events notify your application 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. Each event identifies the affected resource and describes the change. Retrieve the corresponding Client Account API resource when you need its current state or additional details.
Verify every event signature. Deliveries may repeat, so use the event id to avoid processing the same event more than once. Acknowledge successfully received events with an HTTP 200 response.
To start receiving events, see Webhook Registration & Management and Verifying Webhook Signatures.
Downloads
OpenAPI contract
v0.2.0 · currentExplore the schema or generate a client for your integration.
Download OpenAPIResources
Withdrawal
Notifications about the lifecycle of an outbound withdrawal.
Account
Notifications about posted Axiym account movements and changes to Axiym account availability.
Client
Notifications about client records, onboarding, and availability for Client Account API operations.
Address book entry
Notifications about the review and availability of external bank accounts and wallets registered in the selected client's address book.
Deposit
Notifications about the lifecycle of an incoming deposit.
Conversion
Notifications about the lifecycle of a currency conversion.
Webhook subscription
Test notification sent when you request a delivery to a registered endpoint.