Payout Webhook Events

Events about your payees, batches, payments and ledger accounts.

These events cover payouts: the payees you pay, the batches and payments you create, and the ledger accounts that fund them.

EventSent whendata
payee-payability-changedA payee becomes payable or stops being payable.The payee
batch-createdA batch is created.The batch
batch-changedA batch's settings are updated.The batch
payment-createdA payment is added to a batch.The payment
payment-changedAnything on a payment changes.The payment
payment-status-changedA payment is submitted, processed, completed, failed, returned, held or cancelled.The payment
ledger-account-creditedMoney is added to one of your ledger accounts.The amount and the account balance

To follow payouts, most integrations need only payment-status-changed and payee-payability-changed.

See Webhook Events for how deliveries are sent and verified.