---
title: "Settlement Event"
method: POST
path: "settlement"
tags: ["Webhook Events"]
---

# Settlement Event

`POST settlement` (webhook)

Events related to Settlement.

## Headers

- `Webhook-Signature` string, required

## Payload

- object
  - `event_id` string, required: Event ID
  - `event_type` 'settlement.batch.complete' | 'settlement.batch.failure', required: Settlement Event Type
  - `event_body` SettlementEventBody, required: Details about Settlement.
    - `batch_id` string, int64, required: Batch ID
    - `merchant` Merchant, required: Merchant Details
      - `id` string: Merchant identifier
      - `name` string: Merchant name
    - `processor` object, required: Processor Details
      - `id` string: Processor ID
      - `name` string: Processor Name
      - `type` 'cc' | 'ck': Processor Type (cc - Credit Card, ck - Check)
    - `count` integer: Transactions Count
    - `amount` string, number: Transactions Amount
    - `transaction_ids` string[]: Transaction IDs
    - `by_card_type` object: Transactions by Card Type
      - `visa` TransactionSummary: Summary (number of transactions and total amount)
        - `count` integer: Transactions Count
        - `amount` string, number: Transactions Amount
      - `mastercard` TransactionSummary: Summary (number of transactions and total amount)
        - `count` integer: Transactions Count
        - `amount` string, number: Transactions Amount
      - `amex` TransactionSummary: Summary (number of transactions and total amount)
        - `count` integer: Transactions Count
        - `amount` string, number: Transactions Amount
      - `discover` TransactionSummary: Summary (number of transactions and total amount)
        - `count` integer: Transactions Count
        - `amount` string, number: Transactions Amount
      - `diners` TransactionSummary: Summary (number of transactions and total amount)
        - `count` integer: Transactions Count
        - `amount` string, number: Transactions Amount
      - `jcb` TransactionSummary: Summary (number of transactions and total amount)
        - `count` integer: Transactions Count
        - `amount` string, number: Transactions Amount
      - `maestro` TransactionSummary: Summary (number of transactions and total amount)
        - `count` integer: Transactions Count
        - `amount` string, number: Transactions Amount
      - `ebt` TransactionSummary: Summary (number of transactions and total amount)
        - `count` integer: Transactions Count
        - `amount` string, number: Transactions Amount

## Acknowledgement `200`

Return a 200 status to indicate that the data was received successfully

---

[API](https://skmtc.dev/nmi/apis/payments-api.md) - [All operations](https://skmtc.dev/nmi/apis/payments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nmi/apis/payments-api/revisions/c03727f27e27?raw)