# New settlement generated

This event occurs when a settlement is created and ready for processing.

## Example webhook

```json
{
  "id": "evt_piw73n7vcs5ubd7l2xu74syac4",
  "type": "settlement_generated",
  "version": "1.0.4",
  "created_on": "2024-11-04T14:10:26.8373019Z",
  "data": {
    "account": {
      "client_id": "cli_chxj47nausgebpqqhd6syuwaoa",
      "entity_id": "ent_yirkfx5lpxwzyyovxj3bdhfxxe",
      "entity_name": "The Online Retailer UK",
      "entity_cko_legal_entity_code": "cko-ltd-uk",
      "source_id": "ca_aqiswowvowuevmpmypg4a3td6a"
    },
    "settlement_details": {
      "payout_id": "pay_n7shh3ndlazfrl4lc6vdj27xtm",
      "source_currency": "GBP",
      "source_amount": 1019.12,
      "balance_as_of": "2024-11-04T00:00:00+00:00",
      "bank_name": "Test Bank",
      "payment_instrument_id": "src_tpbzvjf3qyhu3lnjttsrw4qvwy",
      "billing_descriptor": "000000012KPB"
    },
    "event_type": "SettlementGenerated",
    "version": "1.0.4"
  },
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/workflows/events/evt_piw73n7vcs5ubd7l2xu74syac4"
    }
  }
}
```
---

## Webhook fields

| Field name | Description |
| --- | --- |
| `client_id`<br>`string` | The unique identifier of the client. |
| `entity_id`<br>`string` | The unique identifier of the associated entity. |
| `entity_name`<br>`string` | The name of the associated entity. |
| `entity_cko_legal_entity_code`<br>`string` | The Checkout.com legal entity that you're contracted with. |
| `source_id`<br>`string` | The unique identifier of the currency account. |
| `payout_id`<br>`string` | The unique identifier of the settlement payout. |
| `source_currency`<br>`string` | The currency from the source account, in [ISO-4217](https://www.checkout.com/docs/developer-resources/codes/currency-codes.md) format. |
| `source_amount`<br>`number` | The _Available_ balance in the corresponding currency account, which is settled to you. |
| `balance_as_of`<br>`string` | The date and time when the _Available_ balance was checked for settlement, in ISO-8601 format. |
| `bank_name`<br>`string` | The name of your bank that the settlement is paid out to. |
| `payment_instrument_id`<br>`string` | The unique identifier of the payment instrument. |
| `billing_descriptor`<br>`string` | The identifier in your bank statement for this settlement transaction. Checkout.com sends the settlement ID as the billing descriptor. |