Deregistering a webhook via API involves removing a previously registered webhook configuration from the application. To disable notification related to particular transaction events, you need to de-register webhook with registered events name.

Once deregistered, the previously registered webhook will no longer be triggered by the API, and notifications will no longer be delivered to the configured endpoint.

This route is secured with processor and vendor token authentication.

​
Endpoint

DELETE   /3p/api/v1/webhook

​
Request Payload

{
    "webhook_url": [
      "https://example.com/webhook/transaction"
    ],
    "event_names": [
      "TransactionCompleted",
      "TransactionFailed"
    ]
}
FieldsTypeIs RequiredDescription
event_namesstring arrayYesPossible Values: TransactionStarted TransactionCaptureStarted TransactionCompleted TransactionFailed TransactionCanceled PayoutFailed PayoutCompleted ClawbackStarted ClawbackFailed ClawbackCompleted BankLinkedSuccessfully BankLinkFailed BankAccountRemoved BusinessCreated BusinessUpdated BatchPayout (only by processor token) RefundPending RefundCaptureStarted RefundCaptureCompleted RefundCaptureFailed RefundPayoutPending RefundPayoutCompleted RefundPayoutFailed BatchRefund (only by processor token) ReversePayoutStarted ReversePayoutCompleted ReversePayoutFailed
webhook_urlstring arrayNo

​
Response Object

{
    "status": true,
    "message": "Webhook de-registered!",
    "data": null,
    "errors": []
}

​
Errors & Warnings

CodeMessage
401
422