Webhook - Batch Payment Approval Status Change

A webhook for when a Batch Payment is Approved/Rejected by a user. Must be subscribed to at a Customer Level.

Batch Payment Approval or Rejections

For Batch Payments, that require a user/users to approve before payments are sent. This is usually for customers that use the Modulr Portal.

This webhook will send when a Batch of Payments awaiting approval is either Approved or Rejected by a user. It is subscribed to at a Customer level.

Note: Batches are created using the batch payment endpoint using Approval Type = BATCH

❗️

Where a BATCH contains Payments that belong to multiple Customers, one webhook will send for each Customer associated with the Batch.

An Individual Payment Approval Webhook is available here

Parameter	Description
EventID	A unique ID for the event
EventTime	Date and Timestamp for the Event - All Dates and times are UTC based.
EventName	Type of event: CUSTOMERBATCHPAYMENTAPPROVALSTATUSCHANGE- a Batch Payment pending user approval has had a status change.
ApprovalStatus	Whether the Batch was APPROVED or REJECTED
BatchID	Modulr Unique Batch Payment ID for the Batch being actioned.
CustomerID	The ID of the Customer that the Batch is associated with. Note: where a Batch is associated with multiple Customers, one webhook per Customer will be received.

Duplication Check

BatchID should be used as your main duplication check, as there are times where the EventId could change. This is important particularly if a webhook has failed and needs to be resent.

Example PAYMENTAPPROVALSTATUSCHANGE Webhook

Approved

Approved Payment Example

{
	"EventId": "28aaaaaa-eee6-4111-11b4-a72050abae02",
  "EventTime": "2025-04-07T13:16:29+0000",
  "CustomerId": "C211111",
  "ApprovalStatus": "APPROVED",
  "BatchId": "B210000000",
  "EventName": "CUSTOMERBATCHPAYMENTAPPROVALSTATUSCHANGE"
}

Rejected

Rejected Payment Example

{
	"EventId": "28aaaaaa-eee6-4111-11b4-a72050abae02",
  "EventTime": "2025-04-07T13:16:29+0000",
  "CustomerId": "C211111",
  "ApprovalStatus": "REJECTED",
  "BatchId": "B210000000",
  "EventName": "CUSTOMERBATCHPAYMENTAPPROVALSTATUSCHANGE"
}