Sign in

v1

latestOpenAPI 3.0.02026-07-144010.7 KB
Webhooks

Create Webhook

Webhook registration for updates on one-off payment statuses and subscription payment statues.<br><br>

post/webhooks

Headers

Content-Typestring
Authorizationstring

Request body

urlstring uri required

The URL of webhook which customer will be recieved the notification

enabled_eventsstring[] required

Event types details:<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> charge.authorized: Notification for when a charge is placed on hold<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> expense.create: Notification for expense creation<br> expense.update: Notification for expense updates<br> card_transaction.create: Notification for card transaction creation<br> card_transaction.update: Notification for card transaction updates<br>

auth_headerstring

authentication header

Example request

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

Response

Successful response

idstring
urlstring uri
auth_headerstring

Example response

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