Settlement

Relevant Links

Settlement Object

Settlement Status Specific Events:

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

Event	Description	Default (on/off)
settlement.created	When the settlement is created	On
settlement.processing	When the settlement is initiated from Tazapay	On
settlement.succeeded	When the settlement reaches the destination bank account (using local rails) or is initiated from Tazapay (using the SWIFT network)	On
settlement.failed	When a settlement fails	On

settlement.created

{
  "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

{
  "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

{
  "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

{
  "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"
}