Webhook - Batch Payment Approval Status Change

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

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

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

Rejected

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