PAYCOW / DOCUMENTATION
Overview
Receive and verify real-time payment events.
Webhooks & Real-Time Notifications
Push architecture -- receive instant HTTP POST notifications on state changes
Setting Up Webhooks
- Implement and deploy a public HTTPS
POSTreceiver before registering it. The route must preserve the exact raw request body. - Log into the PayCow Dashboard and open Developer → Webhooks.
- Enter the final receiver URL and click Save Changes. Saving a URL enables live event delivery.
- Copy the newly generated HMAC-SHA256 Signing Secret (
whsec_...) immediately to a backend-onlyPAYCOW_WEBHOOK_SECRETenvironment variable. - Click Send Test Webhook, return HTTP 2xx, and confirm the result in Webhook Delivery History.
One-time secret display: The plaintext signing secret is returned only when first generated or rotated. If it is lost, rotate it and update your receiver immediately; the previous secret becomes invalid.
Endpoint requirements: Production webhook URLs must use HTTPS and resolve to a public address. Localhost, private networks, embedded URL credentials, and redirects are rejected. The receiver should durably accept the event and respond within 10 seconds.
POST
Merchant Dashboard Webhook Management API
| Endpoint | Method | Description |
|---|---|---|
| /api/operator/webhook | GET | Fetch the authenticated merchant's current webhook URL and masked secret status |
| /api/operator/webhook | POST | Save or clear the URL; returns the plaintext secret only when first generated |
| /api/operator/webhook/rotate-secret | POST | Rotate and return a new signing secret; invalidates the previous secret |
| /api/operator/webhook/test | POST | Queue a signed webhook.test event |
| /api/operator/webhook/events | GET | Read paginated delivery status and attempt history |