Settlement

These are the events for which webhooks will be triggered

settlement.status specific events:

These are the events created and triggered when the status of the settlement object changes.

EventDescriptionDefault (on/off)
settlement.succeededWhen a settlement has succeededOn
settlement.failedWhen a settlement failsOn

settlement.succeeded

{
  "type":"settlement.succeeded",
  "created_at":958793503,
  "data":{
    "id":"stl_ahfafooi7ibakbfahoan",
    "object":"settlement",
    "created_at":7942792,
    ......
    ...... //Entire settlement object
    ........
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

settlement.failed

{
  "type":"settlement.failed",
  "created_at":958793503,
  "data":{
    "id":"stl_ahfafooi7ibakbfahoan",
    "object":"settlement",
    "created_at":7942792,
    ......
    ...... //Entire settlement object
    ........
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

Other events:

EventDescriptionDefault (on/off)
settlement.createdWhen a settlement object is created for the accountOn

settlement.created

{
  "type":"settlement.created",
  "created_at":958793503,
  "data":{
    "id":"stl_ahfafooi7ibakbfahoan",
    "object":"settlement",
    "created_at":7942792,
    ......
    ...... //Entire settlement object
    ........
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}