Skip to main content
POST
/
v1
/
webhooks
/
configure
{
  "url": "https://yoursite.com/webhooks/openpay",
  "events": [
    "payment.completed",
    "payment.failed",
    "payment.expired"
  ]
}

{
  "id": "wh_abc123def456",
  "url": "https://yoursite.com/webhooks/openpay",
  "events": [
    "payment.completed",
    "payment.failed",
    "payment.expired"
  ],
  "active": true,
  "createdAt": "2026-03-26T14:30:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs-openpay.nipuntheekshana.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

This endpoint requires a Bearer token in the Authorization header. 
Authorization: Bearer <your_jwt_token>

​
Body Parameters

​
url
string
required
The HTTPS URL that will receive webhook POST requests. Must be publicly accessible.
​
events
array
An array of event types to subscribe to. If omitted, the webhook will receive all events.Supported events:
  • payment.completed - A payment has been confirmed on-chain
  • payment.failed - A payment failed due to underpayment or error
  • payment.expired - A payment expired before receiving funds
  • subscription.renewed - A recurring subscription payment was collected
  • subscription.cancelled - A subscription was cancelled

​
Response

​
id
string
Unique identifier for the webhook configuration.
​
url
string
The configured webhook URL.
​
events
array
The list of subscribed event types.
​
active
boolean
Whether the webhook is currently active.
​
createdAt
string
ISO 8601 timestamp of when the webhook was configured.
Webhook payloads are signed with ED25519. Use the Get Public Key endpoint to retrieve the verification key.
{
  "url": "https://yoursite.com/webhooks/openpay",
  "events": [
    "payment.completed",
    "payment.failed",
    "payment.expired"
  ]
}

{
  "id": "wh_abc123def456",
  "url": "https://yoursite.com/webhooks/openpay",
  "events": [
    "payment.completed",
    "payment.failed",
    "payment.expired"
  ],
  "active": true,
  "createdAt": "2026-03-26T14:30:00Z"
}