Description of Partner level events for the creation of Webhooks.
Post Body Details
Stax Webhooks POST details vary by event, but they will return the associated object for the event. For example, the create_transaction webhook will POST the transaction object when a transaction is created. The request header will include a stax-event-name value that corresponds to the event_name set on the webhook. Using the same example from above, the following will return in the header: stax-event-name: create_transaction.
All endpoints accept and return JSON.
Partner Webhooks
| Event | Description |
|---|---|
create_dispute | A dispute is created—returns the dispute object. |
create_deposit | A settlement is processed. The webhook payload contains the settlement record. The external_id links the deposit record to the depositDetails. This webhook DOES fire in the sandbox, but the external_id will not match the batch_id. You can use this webhook as a notification and build your system to call the merchant's deposit APIs to get the latest deposit details. |
create_invoice | An invoice is created, including those created by an invoice schedule, and the invoice object is returned. |
create_payment_method | A payment method is created. Returns the payment method object. |
create_transaction | A transaction is created - includes when a transaction is created with Stax.js. Returns transaction object. |
create_user | A user is created. Returns the user object. |
update_dispute | A dispute is updated. Returns dispute object. Triggers when the dispute status is updated. |
update_payment_method | A payment method is updated. Returns the payment method object. The update to the payment method may originate from an action by the merchant user, or, for payment methods enrolled in account updater, from an action by Stax to reflect current information provided by the card brands. |
update_transaction | A transaction is updated. Returns transaction object. Does NOT fire when a transaction gets a settled_at date added. For CC, settlement happens automatically. For ACH, use the update_transaction_settled webhook. |
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
| Event | Description |
|---|---|
create_merchant | Merchant has been created under the partner brand. (This webhook is most useful for our partners who utilize the Stax Landing Page Enrollment option) Returns merchant object. |
update_underwriting | Merchant registration's underwriting status(es) are updated (underwriting_status, underwriting_substatuses, underwriting_note). Continue listening to this webhook until the registration.underwriting_status is APPROVED. Returns the merchant's Registration object. |
update_merchant_status | Merchant.status has changed. When Merchant.status is set to ACTIVE, the merchant can begin processing payments—returns merchant object. |
update_electronic_signature | The merchant signer has signed their merchant application. Returns the merchant's Registration object. Triggered by changes to theregistration.electronic_signature value. |