Skip to content

Events

List and replay webhook events linked to your account.

Events are created on every state change. They correspond directly to webhook payloads.

Endpoints

MethodPathDescription
GET/eventsList events
GET/events/{id}Retrieve an event
POST/events/{id}/resendResend an event

The Event object

idstringoptional
Unique event identifier.
typestringoptional
Event type (e.g. `payment.succeeded`, `transfer.succeeded`).
dataobjectoptional
Event payload — contains the resource object.
created_atdatetimeoptional
ISO 8601 timestamp.

Naming isn't perfectly uniform

Most event types use dot notation (payment.succeeded), but refund creation/failure and payment link events use an underscore instead (refund_created, link_created). Match on the exact string in the tables below rather than assuming a single pattern.

Event catalog

Payments

TypeTrigger
payment.createdPayment initialized
payment.processingPayment submitted to the provider
payment.succeededPayment validated
payment.failedPayment failed
payment.cancelledCancelled by the customer or expired
payment.split.processingA payment split (installment) started processing
payment.split.succeededA payment split succeeded
payment.split.failedA payment split failed

Refunds

TypeTrigger
refund_createdRefund created — underscore, not refund.created
refund.processingRefund submitted to the operator
refund.succeededRefund confirmed
refund_failedRefund failed — underscore, not refund.failed
refund.cancelledRefund cancelled

Transfers

TypeTrigger
transfer.createdTransfer created
transfer.processingSubmitted to the operator
transfer.succeededDelivered
transfer.failedFailed

Customers

TypeTrigger
customer.createdCreated
customer.updatedUpdated
customer.deletedDeleted

Beneficiaries

TypeTrigger
beneficiary.createdCreated
beneficiary.updatedUpdated
beneficiary.deletedDeleted

Invoices

TypeTrigger
invoice.createdCreated
invoice.updatedUpdated (sent, marked paid, cancelled, …)
invoice.deletedDeleted
TypeTrigger
link_createdCreated — underscore, not link.created
link_updatedUpdated
link_deletedDeleted

Accounts (Sync / subaccounts)

TypeTrigger
account.createdSub-account created
account.updatedSub-account updated
account.deauthorizedSub-account removed or access revoked
account.payment_activatedPayment capability enabled
account.payment_suspendedPayment capability suspended

Disputes

TypeTrigger
dispute.createdNew dispute opened
dispute.updatedDispute updated
dispute.wonResolved in your favor
dispute.lostResolved against you
dispute.closedClosed
dispute.deletedDeleted

Webhook endpoints

TypeTrigger
webhook_endpoint.createdEndpoint registered
webhook_endpoint.updatedEndpoint updated
webhook_endpoint.deletedEndpoint removed

Other

TypeTrigger
balance.updatedAvailable/pending/reserved balance changed
fee.receivedA platform fee was collected (Sync)