Merchant Webhook Events

You can configure webhooks via the API to be notified about events that happen in your account. Generally, this will be the same result as a GET call performed.

For example the payload of create_transaction webhook will have the same payload of GET transaction/id

Note: This is only for what webhooks are available and how to create them. A service such as webhook.site can be used to create custom webhooks

Webhook	Description
create_customer	A customer is created. Returns Customer object.
create_deposit	A settlement is processed. The payload of the webhook contains the settlement record. The `external_id` is the connector between the deposit record and the deposit details. This webhook DOES fire in the sandbox, but in the sandbox environment, the external_id will not match the batch_id - in the sandbox, you can use this webhook as a notification and build your system to call out to the merchant's deposit APIs to get the latest deposit details.
create_dispute	A dispute is created. Returns dispute object. Dispute includes the associated transaction_id.
create_invoice	An invoice is created, which includes invoices created by an invoice schedule. Returns invoice object.
create_item	An item is created.
create_scheduled_invoice	An invoice schedule is created. Returns Invoice Schedule.
create_transaction	A transaction is created, including those made with Stax.js. Returns transaction object.
create_user	A user is created.
create_webhook	A webhook is created.
delete_item	An item is deleted.
delete_scheduled_invoice	An invoice schedule is deleted.
delete_webhook	A webhook is deleted.
update_item	An item is updated.
send_invoice	An invoice is sent via email or text.
set_branding	Branding is set.
set_gateway	A gateway is set.
set_plan	A plan is set.
update_customer	A customer is updated.
update_dispute	A dispute is updated. Returns dispute object.
update_invoice	An invoice is updated.
update_scheduled_invoice	An invoice schedule is updated.
update_transaction	A transaction is updated. Returns transaction object.
update_user	A user is updated.
update_payment_method	A payment method is updated. With auto updater, if a payment method is updated by Stax to reflect updated information from the card brands.
update_transaction_settled	An ACH transaction has either settled or not settled. Returns original transaction object. If the transaction is settled, the `settled_at` date will be populated. If the transaction was clawed back, the transaction's `child_transactions` array will include the associated void transaction.

Merchant Enrollment Webhooks

Webhook	Description
update_underwriting	Merchant registration's underwriting status(es) are updated.
update_merchant_status	Merchant status has changed.
update_electronic_signature	Merchant signer has signed their merchant application.