Payout Events#

CasaPay sends webhook events for payout lifecycle changes.

Event Types#

Event	Description
`payout.created`	A new payout was created
`payout.updated`	A payout was updated
`payout.paid`	A payout was successfully delivered
`payout.failed`	A payout failed
`payout.canceled`	A payout was canceled
`balance.available`	Funds became available in your balance

Event Object#

{
  "id": "evt_po_abc123",
  "object": "event",
  "type": "payout.paid",
  "data": {
    "object": {
      "id": "po_xyz789",
      "object": "payout",
      "amount": 1150000,
      "currency": "gbp",
      "status": "paid",
      "destination": "ba_abc123",
      "arrival_date": 1706572800
    }
  },
  "created": 1706572800
}

Handling Payout Events#

app.post('/webhooks/casapay', async (req, res) => {
  const event = req.body;

  switch (event.type) {
    case 'payout.paid':
      await notifyLandlord(event.data.object);
      break;
    case 'payout.failed':
      await investigateFailure(event.data.object);
      break;
  }

  res.status(200).send();
});