Webhooks

Overview

This section describes the Webhook endpoint used to send events to ZidPay. It outlines all the necessary webhook events and their specifications.

Path:
/api/webhook/v1/thirdpartywebhook

Request Model:

Input Parameter	Type	Description	Required
type	string	Event type Types: “merchant_linked”, “payment_paid”, “refund_status_changed”	Y
thirdPartyId	string	Provider Unique ID, Which is assigned to each provider on the initial phases of the integration	Y
merchantId	string	Merchant ID on the provider side	Y
data	Object	Each Event has its own object dto, Examples: Link Merchant Event, Payment Paid Event, Refund Event	Y