Axiym Direct Trade API Events
This reference describes the webhook events Axiym sends to your registered HTTPS endpoint. These are outbound notifications received by your application, not API operations for you to call.
Event payloads contain the identifiers and status information needed to recognize and route a change. Every event describes a resource your organization owns, so the payloads carry no clientId, including when an operation supports a customer workflow. If you also operate the Client Trade API, its client-owned resource events carry a clientId. Treat the corresponding Direct Trade API resource as the authoritative source of its current state and retrieve it when your workflow needs additional or up-to-date details. Verify every event signature, use the event id to process duplicate deliveries safely, and 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.1.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.
Address book entry
Notifications about the review and availability of an address book entry — an owned external bank account or wallet used for deposits and withdrawals. The event contract retains the `destination.*` names.
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.