Skip to main content

Webhook Event Types

Complete list of webhook event types available in Anton Payments, including payout, payee, and batch events.

Written by Ryan O
Updated today

Overview

Anton sends webhook notifications for events across your account. Each event type corresponds to a specific action or status change. Subscribe only to the events your system needs to process.

Payout Events

Payout events track the full lifecycle of a payout from creation to final resolution.

  • payout.created -- A new payout has been created. The payout is queued for compliance screening.

  • payout.screening -- The payout has entered compliance screening. Anton is running sanctions, PEP, and risk checks on the transaction.

  • payout.approved -- The payout has passed compliance screening and been approved through the maker-checker workflow (if applicable).

  • payout.processing -- The payout has been submitted to the payment rail for execution.

  • payout.sent -- The payment rail has confirmed dispatch of the funds. Delivery to the recipient is in progress.

  • payout.completed -- The payout has been delivered successfully to the recipient.

  • payout.failed -- The payout could not be completed. Check the failure_reason field in the event data for details.

  • payout.returned -- Funds were returned after a delivery attempt. This can happen when bank details are incorrect or the recipient's account is closed.

  • payout.cancelled -- The payout was cancelled before it was sent to the payment rail.

Payee Events

Payee events notify you when beneficiary records change.

  • payee.created -- A new payee (beneficiary) has been created in your account.

  • payee.updated -- A payee's details have been modified. The event data includes the updated fields.

  • payee.deleted -- A payee has been removed from your account.

Batch Events

Batch events track the processing of batch payout uploads.

  • batch.completed -- All payouts in the batch have reached a terminal state (completed, failed, or returned). The event data includes a summary of results.

  • batch.failed -- The batch processing encountered an error that prevented it from completing. Individual payout statuses may vary.

Event Payload Structure

Every webhook event follows the same JSON structure:

{
  "id": "evt_cng3q8s6ek9kc5qg1h3g",
  "type": "payout.completed",
  "created_at": "2026-02-14T10:30:00Z",
  "data": {
    "id": "pay_cng3q8s6ek9kc5qg1h2g",
    "status": "completed",
    "amount": "1000.00",
    "currency": "USD"
  }
}

Key fields:

  • id -- Unique event identifier. Use this to deduplicate events in your handler.

  • type -- The event type string (e.g., payout.completed).

  • created_at -- ISO 8601 timestamp of when the event occurred.

  • data -- The resource object associated with the event, containing the relevant details.

Subscribing to Events

When creating or updating a webhook subscription, specify the event types you want to receive in the events array. You can subscribe to any combination of events on a single endpoint, or use separate endpoints for different event categories.

Did this answer your question?