Skip to main content
The payment.mailed event is sent when a check-based payment has been successfully handed off for mailing. This event indicates that the physical mailing process has started. Delivery to the recipient may take additional time depending on the selected mailing method.

​
Example Payload

{
  "event": "payment.mailed",
  "id": "5869eaba-ecea-4640-85ad-8e2dd93243d6",
  "data": {
    "payment_id": "5869eaba-ecea-4640-85ad-8e2dd93243d6",
    "status": "mailed",
    "amount": 200.0
  },
  "eventGeneratedTime": 1756729948.128641
}

​
Data Fields

​
payment_id
string
Unique identifier of the payment transaction.
​
status
string
Current payment status. Always mailed for this event.
​
amount
float
Payment amount expressed in the major currency unit (for example, USD).

​
Handling the Event

Use this event to:
  • Mark the payment as mailed in your system
  • Notify the payer or recipient that the check is in transit
  • Track check-based payment lifecycle stages
  • Support customer inquiries about mailed payments