---
title: "Batch payment initiations state change"
method: POST
path: "batch-payment-initiations#state-change"
tags: ["webhook-event", "batch-group"]
---

# Batch payment initiations state change

`POST batch-payment-initiations#state-change` (webhook)

Triggered when the payment initiation state of a batch group payment changes.

The expected state of a batch payment initiation can be one of: 
- `NEW`
- `PROCESSING`
- `COMPLETED`
- `FAILED`
- `CHARGED_BACK`

* Event type: `batch-payment-initiations#state-change`
* Profile level subscriptions: Not Supported
* Application level subscriptions: Supported

Events may not be delivered in the order they occurred. Use `data.occurred_at` to reconcile the order.
See the [Event ordering guide](/guides/developer/webhooks/event-ordering) for details.

See the [Webhooks guide](/guides/developer/webhooks) for setup instructions, signature verification, and best practices.

## Headers

- `X-Signature-SHA256` string
- `X-Delivery-Id` string, uuid
- `X-Test-Notification` boolean

## Payload

- union
  - V40022
    - `schema_version` '4.0.0' — Version of the event schema. Determined by the `schema_version` on your [webhook subscription](/api-reference/webhook).
    - `subscription_id` string, uuid — ID of the webhook subscription that triggered this event.
    - `event_type` string — Event type identifier
    - `sent_at` string, date-time — Timestamp when the event was sent.
    - `data` object
      - `resource` object
        - `id` integer — Payment initiation ID
        - `batch_group_id` string — Batch group ID
        - `profile_id` integer — The ID of the profile this payment belongs to.
      - `previous_status` 'NEW' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CHARGED_BACK' — Previous payment initiation state.
      - `current_status` 'NEW' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CHARGED_BACK' — Current payment initiation state.
      - `occurred_at` string, date-time — When the payment initiation state change occurred.
      - `return_code` string — Return code of the underlying payment system.
  - V20021
    - `schema_version` '2.0.0' — Version of the event schema. Determined by the `schema_version` on your [webhook subscription](/api-reference/webhook).
    - `subscription_id` string, uuid — ID of the webhook subscription that triggered this event
    - `event_type` string — Event type identifier
    - `sent_at` string, date-time — Timestamp when the event was sent
    - `data` object
      - `resource` object
        - `id` integer — Payment initiation ID
        - `batchGroupId` string — Batch group ID
        - `profileId` integer — The ID of the profile this payment belongs to
      - `previousStatus` 'NEW' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CHARGED_BACK' — Previous payment initiation state
      - `currentStatus` 'NEW' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'CHARGED_BACK' — Current payment initiation state
      - `occurredAt` string, date-time — When the payment initiation state change occurred
      - `returnCode` string — Return code of the underlying payment system

## Acknowledgement `200`

Return any `2xx` status to acknowledge receipt of the event.

- object
  - `status` string

---

[API](https://skmtc.net/wise/apis/platform-api.md) · [All operations](https://skmtc.net/wise/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wise/platform-api/revisions/4907a1d269ab/schema)