Skip to main content

Check Payment Webhook Events

The following webhook events are available for Check Payments:

EventDescription
checkPayment.createdFired when a check payment is created.
checkPayment.pendingFired when a check payment status changes to Pending.
checkPayment.inProductionFired when a check payment has been sent to the printers.
checkPayment.inDeliveryFired when a check payment has been accepted by the mail service and is en route.
checkPayment.deliveredFired when a check payment has been delivered.
checkPayment.canceledFired when a check payment has been canceled.
checkPayment.rejectedFired when a check payment has been rejected.
checkPayment.processedFired when a check payment has been processed and the deposit account was debited.
checkPayment.markedForReturnFired when a check payment has been marked for return.
checkPayment.returnedFired when a check payment has been returned.
checkPayment.returnToSenderFired when a check payment could not be delivered and is being returned to the sender.
checkPayment.deliveryStatusChangedFired when a check payment's delivery status changes.
checkPayment.additionalVerificationRequiredFired when a check payment requires additional verification.
checkPayment.additionalVerificationApprovedFired when additional verification for a check payment has been approved.
transaction.createdFired when a debit transaction is created for the check payment.

previousStatus on check payment events

Several check payment webhook payloads include a string attribute previousStatus. It names the check payment’s status immediately before the event was recorded (for example PendingReview before checkPayment.processed).

When previousStatus is "Unknown"

You may see previousStatus: "Unknown" instead of a concrete status name. That value is emitted when the processing path does not pass a prior status into the webhook payload—not because Unit lacked the earlier status on the check payment resource.

For other reprocess outcomes (for example transitions into PendingReview or MarkedForReturn), previousStatus is usually populated when the pipeline supplies an initial status; if it does not, "Unknown" can appear there as well.

See the Webhook Events documentation for detailed information about each event's payload and structure.