Webhook - Payment Approval Status Change

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

Payment Approval or Rejections

Some Payments may have approval rules, where a user/users must approve before the payment is sent. This is usually for customers that use the Modulr Portal.

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

Note: This webhook sends when an Individual Payment is approved. This payment would be created either as individual payments or a batch payment of type BULK

A Batch Payment Approval Status webhook is coming in future

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: PAYMENTAPPROVALSTATUSCHANGE - a Payment pending user approval has had a status change.
ApprovalStatus	Whether the Payment was APPROVED or REJECTED
PaymentID	Modulr Unique Payment Reference for the payment sent.
CustomerID	The ID of the Customer that the Payment is associated with
ExternalReference	This is the reference you can set on the payment request to correlate back to your system.

Duplication Check

PaymentId 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",
  "ExternalReference": "",
  "CustomerId": "C211111",
  "ApprovalStatus": "APPROVED",
  "PaymentId": "P210000000",
  "EventName": "PAYMENTAPPROVALSTATUSCHANGE"
}

Rejected

Rejected Payment Example

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