Sign in

v1

latestOpenAPI 3.0.02026-07-144010.7 KB
Webhooks

Update Webhook

Allows a user to update webhook details.<br><br>

patch/webhooks/{webhookId}

Path parameters

webhookIdstring required

Webhook ID

Headers

Content-Typestring
Authorizationstring

Request body

urlstring uri required

The URL which the customer will be redirected to after a successful payment.

enabled_eventsstring[] required

The URL of webhook which customer will be recieved the notification:<br> charge.failed: Notification for failed one-off payments<br> charge.succeeded: Notification for successful one-off payments<br> charge.refund_initiated: Notification for initializing the refund<br> charge.refunded: Notification for the successful refund<br> charge.refund_failed: Notification for the failed refund<br> charge.card_verified: Notification for card verification payment<br> subscription.failed: Notification for failed subscription payments<br> subscription.succeeded: Notification for successful subscription payments<br> payment_link.create: Notification for successfully create payment link<br> payout.processed: Notification for settled payout<br> payout.failed: Notification for rejected payout<br>

auth_headerstring

authentication header

Example request

{
  "id": "MB-WH-FBA601A8DA",
  "url": "https://webhook.site/e9145367-01cc-45f9-bebb-69775badb883",
  "enabled_events": [
    "charge.failed"
  ],
  "auth_header": "authentication header"
}

Response

Successful response

idstring

The identifier of webhook

urlstring uri

The URL which the customer will be redirected to after a successful payment.

auth_headerstring

authentication header

Example response

{
  "url": "https://webhook.site/e9145367-01cc-45f9-bebb-69775badb883",
  "enabled_events": [
    "charge.failed"
  ],
  "auth_header": "test",
  "id": "MB-WH-FBA601A8DA"
}