Skip to main content

​
Settlement Status Specific Events:

These are the events created and triggered when the status of the settlement object changes.
EventDescriptionDefault (on/off)
settlement.createdWhen the settlement is createdOff
settlement.processingWhen the settlement is initiated from TazapayOff
settlement.succeededWhen the settlement reaches the destination bank account (using local rails) or is initiated from Tazapay (using the SWIFT network)Off
settlement.failedWhen a settlement failsOff

​
settlement.created

JSON
{
  "type":"settlement.failed",
  "created_at":"2025-04-29T12:34:56+05:30",
  "data":{
    "id":"stl_ahfafooi7ibakbfahoan",
    "object":"settlement",
    "created_at":"2025-04-29T12:34:56+05:30",
    ......
    ...... //Entire settlement object
    ........
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

​
settlement.processing

JSON
{
  "type":"settlement.failed",
  "created_at":"2025-04-29T12:34:56+05:30",
  "data":{
    "id":"stl_ahfafooi7ibakbfahoan",
    "object":"settlement",
    "created_at":"2025-04-29T12:34:56+05:30",
    ......
    ...... //Entire settlement object
    ........
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

​
settlement.succeeded

JSON
{
  "type":"settlement.succeeded",
  "created_at":"2025-04-29T12:34:56+05:30",
  "data":{
    "id":"stl_ahfafooi7ibakbfahoan",
    "object":"settlement",
    "created_at":"2025-04-29T12:34:56+05:30",
    ......
    ...... //Entire settlement object
    ........
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}

​
settlement.failed

JSON
{
  "type":"settlement.failed",
  "created_at":"2025-04-29T12:34:56+05:30",
  "data":{
    "id":"stl_ahfafooi7ibakbfahoan",
    "object":"settlement",
    "created_at":"2025-04-29T12:34:56+05:30",
    ......
    ...... //Entire settlement object
    ........
  },
  "id":"evt_auigfianfoangohuehg",
  "object":"event"
}