API Reference
Start typing to search…
  1. BXNK APIs
  2. Webhooks

Enable or disable a webhook endpoint

patch
https://sandbox-api.bxnk.com/api/v1/product-apis/psp//webhooks//status

Enable or disable a webhook endpoint.

Authentication

Requires X-Access-Key and X-Secret-Key headers.

Path parameters

  • pspId (number): the PSP identifier
  • endpointId (number): the webhook endpoint identifier

Request body

JSON payload matching UpdateWebhookStatusDto.

Required fields:

  • isActive (boolean)

Response

  • 200: Webhook endpoint updated successfully. Returned data (WebhookEndpointResponseDto) includes:
    • id
    • pspId
    • merchantId (nullable)
    • url
    • isActive
    • createdAt
    • updatedAt
  • 400: Bad request
  • 401: Unauthorized
  • 403: Forbidden
  • 404: Not found
  • 500: Internal server error
Language
Credentials
Response
Click Try It! to start a request and see the response here!