Webhooks

We use webhooks to send you real-time POST notifications when events occur in our platform. We will send all events as a JSON payload to a single HTTPS endpoint that you provide.

To configure or update your webhook endpoint, please contact our Technical Support team at integrationsupport@shieldpay.com.

Responding to a Webhook

To acknowledge successful receipt of a webhook, your endpoint must return an HTTP 200 OK status code. Any other response, including a timeout, will be treated as a delivery failure.

Failed Deliveries

If a webhook delivery fails, we will retry sending it with a 5-minute interval between attempts. We will continue to retry for 24 hours. After this period, we will stop all attempts for that specific event.

Available Webhooks

The type property in the JSON payload identifies the event. The following webhooks are available:

• KYC Success
• KYC Fail
• Project status update
• Source status update
• Use status update
• Payee verified

See our API Reference for full details on each webhook.