Events

The Payment API emits separate events for significant payout milestones and Axiym account changes. The event name tells you what changed without requiring you to infer a transition from two status values.

Payout events

Event	Sent when
`payout.created`	The payout has been prepared and is awaiting partner confirmation.
`payout.approved`	The exact payout instruction has passed validation and transaction controls.
`payout.rejected`	Validation or transaction controls reject the payout before local execution.
`payout.settled`	The sell amount and fee have been debited from the funding account.
`payout.submitted`	The instruction has been submitted to the local payout provider.
`payout.completed`	The payout has completed successfully through the local banking route.
`payout.canceled`	The payout has been canceled before local execution.
`payout.failed`	The payout cannot proceed or complete successfully.
`payout.returned`	A submitted payout has been returned and requires reconciliation.

Axiym account events

Event	Sent when
`account.credited`	A posted movement credits the Axiym account. The event carries the movement amount.
`account.debited`	A posted movement debits the Axiym account. The event carries the movement amount.
`account.activated`	The Axiym account becomes active, initially or after a suspension.
`account.suspended`	The Axiym account is suspended.
`account.closed`	The Axiym account is permanently closed.

Account credit and debit events describe immutable posted movements, so the movement amount is included but the current balance is not. Fetch the account when you need its latest balance. When a movement is associated with a payout, relatedResourceType is PAYOUT and relatedResourceId contains its payoutId.

Webhooks are notifications, not state transfer. Fetch the corresponding payout or account through its resource endpoint when you need the complete or latest state.

Event envelope

{
  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "timestamp": "2026-08-04T05:07:30Z",
  "type": "payout.settled",
  "data": {
    "payoutId": "9b4e2a1c-6d3f-4a8e-bc7d-1f2a3b4c5d6e",
    "quoteId": "978490c4-4227-4a75-9820-5f90482bb78b",
    "accountId": "d96b90c1-b69e-4f5d-8154-46ecfcad8d0a",
    "clientReference": "PAYOUT-2026-001",
    "status": "SETTLED"
  }
}

Field	Description
`id`	Unique event identifier used for de-duplication.
`timestamp`	Time Axiym created the event.
`type`	Event name.
`data`	Compact identifiers and status information used to route and correlate the event.

The Events reference is the source of truth for the event catalogue and payload schemas.

Processing guidance

Verify the signature before parsing or processing the payload.
Process each event id once.
Use the resource identifiers and partner references to correlate the notification.
Retain the resource identifiers and use the corresponding Payment API path for reads.
Do not move internal state backward because an older event arrives late.
Fetch the corresponding resource before taking an action that depends on its latest state.

Payout events

Axiym account events

Event envelope

Processing guidance

On this page