BAbanqzinc
Webhook

Register or update a merchant webhook URL

Changed on

Register or update a merchant webhook URL

post/api/v1/webhooks

Request

Request body

merchant_idstring uuid

Merchant ID. Defaults to the logged-in merchant if not provided. Required for admin tokens.

webhook_urlstring uri required

The URL where webhook notifications will be sent

Example request

{
  "merchant_id": "550e8400-e29b-41d4-a716-446655440000",
  "webhook_url": "https://example.com/webhook"
}

Response

Success

successboolean required

Indicates if the request was successful

Example response

{
  "success": true,
  "data": {
    "webhook_url": "https://example.com/webhook",
    "message": "Webhook URL successfully configured"
  }
}

Changes

  • b372e7d5563dRevision changes
    • breaking

      the / response's property type changed from string to no type for status

    • warning

      removed the optional property / from the response with the status

    • info

      added the new optional request property

    • info

      added the optional property / to the response with the status

    • info

      added subschema #1 subschema #2 to the / response property allOf list for the response status

  • 6637b341d86dRevision changes
    • info

      endpoint added