Skip to content

Batch payment initiations state change
Webhook

Request

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 for details.

See the Webhooks guide for setup instructions, signature verification, and best practices.

Headers
X-Signature-SHA256string

RSA-SHA256 signature of the request body, Base64 encoded. Verify this against the Wise public key to ensure the request is authentic and has not been tampered with.

Example:t7FMhk3OARMgwqz0LJXO...
X-Delivery-Idstring, (uuid)

Unique identifier for this webhook delivery attempt.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890
X-Test-Notificationboolean

Present with the value true if this is a test notification sent to verify your callback URL during subscription setup.

Example:true
Bodyapplication/json
schema_versionstring

Version of the event schema. Determined by the schema_version on your webhook subscription.

Value:"4.0.0"
Example:"4.0.0"
Discriminator
subscription_idstring, (uuid)

ID of the webhook subscription that triggered this event.

Example:"01234567-89ab-cdef-0123-456789abcdef"
event_typestring

Event type identifier

Example:"batch-payment-initiations#state-change"
sent_atstring, (date-time)

Timestamp when the event was sent.

Example:"2020-01-01T12:34:56.123Z"
dataobject
Payload
{
  "schema_version": "4.0.0",
  "subscription_id": "01234567-89ab-cdef-0123-456789abcdef",
  "event_type": "batch-payment-initiations#state-change",
  "sent_at": "2020-01-01T12:34:56.123Z",
  "data": {
    "resource": {
      "id": 12345,
      "batch_group_id": "068e186d-9632-4937-b753-af3e53f4d0b0",
      "profile_id": 2
    },
    "previous_status": "NEW",
    "current_status": "PROCESSING",
    "occurred_at": "2021-04-13T19:51:41.423Z",
    "return_code": "200"
  }
}

Responses

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

Bodyapplication/json
statusstring
Example:"ok"
Response
{
  "status": "ok"
}