Events
Account API webhooks cover withdrawals, account movements, whitelisted own
accounts, and subscription tests. Each event is delivered as a webhook envelope
with a type and a compact data payload.
Webhooks are notifications, not state transfer: the payload carries just
enough to route the event and correlate it with your records. Fetch the
authoritative withdrawal via GET /withdrawals/{withdrawalId} when you need
amounts, fees, or the transaction hash.
| Field | Description |
|---|
id | Unique webhook event identifier. Use this for de-duplication. |
timestamp | Time when Axiym created the event. |
type | Event name. |
data | Compact event payload. |
The exact data schema and a full payload example for every event are in the
Events reference — it is the source of truth for
webhook payloads.
| Event | Meaning |
|---|
withdrawal.created | A withdrawal was created and is awaiting execution. |
withdrawal.held | A withdrawal was stopped by a review, compliance, or operational gate. |
withdrawal.completed | A withdrawal completed successfully. |
withdrawal.canceled | A withdrawal was canceled before completion. Carries reasonCode. |
withdrawal.rejected | A withdrawal was rejected and will not complete. Carries reasonCode. |
| Event | Meaning |
|---|
account.credited | A posted movement credited the account. Carries the movement amount. |
account.debited | A posted movement debited the account. Carries the movement amount. |
account.credited / account.debited describe immutable posted movements,
so the amount is part of the event; the current balance is not — fetch it via
GET /accounts/{accountId}. Movements linked to an API resource carry
relatedResourceType / relatedResourceId so you can avoid double-counting
withdrawals you already track.
| Event | Meaning |
|---|
destination.created | A new destination was registered and is awaiting review. |
destination.activated | The whitelisted own account became usable for withdrawals. |
destination.suspended | The whitelisted own account was temporarily suspended. |
destination.closed | The whitelisted own account was permanently retired. |
| Event | Meaning |
|---|
subscription.test | A test delivery requested for a webhook subscription. Its data is { "test": "OK" }. |
- Verify the webhook signature before processing the payload.
- De-duplicate deliveries by the event
id.
- Use
withdrawalId and externalReference to correlate the event with your
own records.
- Treat webhooks as at-least-once delivery. Duplicate events can occur.
- Fetch the withdrawal from the API if ordering matters or if you need the
latest state before continuing.
