NMI HomeLegacy Documentation
Partner PortalMerchant Portal

Settlement Events

Here you can find all the events that are related to settlement activity.

List of Events

Event NameDescription
settlement.batch.completeBatch settlement completed successfully
settlement.batch.failureBatch settlement failed

Event Samples

{
  "event_id": "11750910-bd03-4f9a-871a-786203df177f",
  "event_type": "settlement.batch.complete",
  "event_body": {
    "batch_id": "12345678",
    "count": 4,
    "amount": "402.81",
    "merchant": {
      "id": "123456",
      "name": "Test Account"
    },
    "processor": {
      "id": "ccprocessor",
      "name": "CC Processor",
      "type": "cc"
    },
    "by_card_type": {
      "visa": {
        "count": 4,
        "amount": "402.81"
      }
    },
    "transaction_ids": [
      "1234000000",
      "1234000001",
      "1234000002",
      "1234000003"
    ]
  }
}

{
  "event_id": "dfe8156d-5dd9-43ac-8928-3cf70ef74108",
  "event_type": "settlement.batch.failure",
  "event_body": {
    "batch_id": "123456",
    "merchant": {
      "id": "123456",
      "name": "Test Merchant"
    },
    "processor": {
      "id": "ccprocessor",
      "name": "CC Processor",
      "type": "cc"
    }
  }
}