Payout Webhooks

Summary of payout events

To configure these events, please contact [email protected] with your organization name, environment, events & webhook URL.

Events

Event	Description
payout.paying	The payout has been released.
payout.paid	The payout has cleared.
payout.on_hold	The payout is in review or placed on hold.
payout.canceled	The payout has been canceled.
payout.failed	The payout has failed.

Sample Response

Payout Webhook Sample Response

{
  "id": "c74cc6ea-552f-4f95-a1a6-99cde3acd733",
  "type": "payout.paid",
  "data": {
    "id": "9dbc6515-fcd1-417d-88dc-abc",
    "status": "paid",
    "paid_at": "2023-04-01T12:33:27.282Z",
    "quote_id": "329188ca-237e-4bf2-8a0f-c3abc",
    "failed_at": null,
    "paying_at": null,
    "created_at": "2023-03-24T12:13:17.267Z",
    "program_id": "98f7f981-09aa-4658-9d74-abc",
    "updated_at": "2023-04-01T12:33:27.325Z",
    "invoice_id": "cd3e7511-c59e-4b5b-b438-93d5583aede3",
    "payout_type": "commission",
    "payable_account": {
      "id": "a0675645-c126-4b86-9503-abc",
      "bank_name": "Chase",
      "owner_name": "John Doe Agency",
      "usage_type": "commission_account",
      "routing_number": "...",
      "last_four_digits": "1234"
    },
    "net_payout_amount_cents": 100000,
    "gross_payout_amount_cents": 100000,
    "net_payout_amount_currency": "USD",
    "gross_payout_amount_currency": "USD"
  }
}

📘

If you have any questions or feedback, we'd love to hear from you. Please reach out to [email protected]