BYbyaccrue
Webhook Topics

CounterpartyPayoutCreated

Fired when a payout is created for a counterparty and submitted for processing. status is the payout's initial state, which may be Approved, NeedsApproval, or Processing depending on your approval configuration.

A duplicate create — the same idempotency key replayed — returns the existing payout and does not fire a second event.

The included payload mirrors the payout resource — payoutId, counterpartyId, amount (in cents), currency, status, description, and effectiveDate — so you can act on the event without re-reading the payouts API.

postWebhookcounterpartyPayoutCreated

Payload

idstring uuid required

Unique identifier for the object.

type'WebhookEvent' required

Example payload

{
  "attributes": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "walletId": "123e4567-e89b-12d3-a456-426614174000"
  },
  "included": [
    {
      "attributes": {
        "payoutId": "po_a1b2c3d4e5",
        "counterpartyId": "123e4567-e89b-12d3-a456-426614174000",
        "merchantId": "123e4567-e89b-12d3-a456-426614174000",
        "amount": 5000,
        "currency": "USD",
        "status": "Sent",
        "description": "Payout to Acme Vendor",
        "effectiveDate": "2026-08-28"
      }
    }
  ]
}

Response

Return a 200 status to indicate that the data was received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.