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

  1. Implement and deploy a public HTTPS POST receiver before registering it. The route must preserve the exact raw request body.
  2. Log into the PayCow Dashboard and open Developer → Webhooks.
  3. Enter the final receiver URL and click Save Changes. Saving a URL enables live event delivery.
  4. Copy the newly generated HMAC-SHA256 Signing Secret (whsec_...) immediately to a backend-only PAYCOW_WEBHOOK_SECRET environment variable.
  5. 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
EndpointMethodDescription
/api/operator/webhookGETFetch the authenticated merchant's current webhook URL and masked secret status
/api/operator/webhookPOSTSave or clear the URL; returns the plaintext secret only when first generated
/api/operator/webhook/rotate-secretPOSTRotate and return a new signing secret; invalidates the previous secret
/api/operator/webhook/testPOSTQueue a signed webhook.test event
/api/operator/webhook/eventsGETRead paginated delivery status and attempt history