# Webhooks

**Batch Webhook Structure**\
Data Type: JSON

The webhook payload is delivered in **JSON** format, a structured data format commonly used for APIs. Each payload includes:

| Variable          | Type    | Description                                              |
| ----------------- | ------- | -------------------------------------------------------- |
| `event`           | String  | The event will following current progress of this batch. |
| `amount`          | Integer | Batch total amount in cent.                              |
| `currency`        | String  | Currency of this batch.                                  |
| `batch_id`        | String  | Unique ID of the updated batch.                          |
| `status`          | String  | Status of the current batch progress.                    |
| `batch_run_time`  | Integer | Unix timestamp of the batch running time.                |
| `batch_reference` | String  | Reference of this batch.                                 |
| `process_amount`  | Integer | Actual batch total amount in cent when batch processed.  |
| `total_failed`    | Integer | Total of failed payout records.                          |
| `total_tx`        | Integer | Total of payout records.                                 |
| `subccount_id`    | String  | Unique ID of the updated batch's subaccount.             |
| `created_at`      | Integer | Unix timestamp when batch record created.                |
| `timestamp`       | Integer | Unix timestamp of the event.                             |

**Batch Notification Event**

<table><thead><tr><th width="199">Event</th><th>Description</th></tr></thead><tbody><tr><td>batchUpdate</td><td>Indicates that batch have been updated in a single operation.</td></tr></tbody></table>

**Batch Notification Status**

<table><thead><tr><th width="202">Status</th><th>Description</th></tr></thead><tbody><tr><td>open</td><td>Batch is in the open for new created payout.</td></tr><tr><td>queue</td><td>Batch is in the queue, waiting to be processed.</td></tr><tr><td>in_progress</td><td>Batch is currently in progress.</td></tr><tr><td>settled</td><td>Batch has been successfully settled.</td></tr><tr><td>cancelled</td><td>Batch has been cancelled.</td></tr><tr><td>failed</td><td>Batch process has failed.</td></tr></tbody></table>

**Example**

```json
{
    "event": "batchUpdate",
    "amount": 2440,
    "currency": "AUD",
    "batch_id": "13b2bbf5-fc4e-4882-8dfc-04d760b4d60b",
    "status": "queue",
    "batch_run_time": 1724965200000,
    "batch_reference": "BATCH_13b2bbf5-fc4e-4882-8dfc-04d760b4d60b",
    "process_amount": 0,
    "total_failed": 0,
    "total_tx": 1,
    "subccount_id": "3dc81811-8cdb-49c6-8f9e-9125ea4540b0",
    "created_at": 1710084228000,
    "timestamp": 1710091428000
}
```