{
"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"
}
Webhooks
Configure Webhook
Set or update the webhook endpoint URL and subscribe to specific events
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"
}
Authentication
This endpoint requires a Bearer token in theAuthorization header.
Authorization: Bearer <your_jwt_token>
Body Parameters
string
required
The HTTPS URL that will receive webhook POST requests. Must be publicly accessible.
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-chainpayment.failed- A payment failed due to underpayment or errorpayment.expired- A payment expired before receiving fundssubscription.renewed- A recurring subscription payment was collectedsubscription.cancelled- A subscription was cancelled
Response
string
Unique identifier for the webhook configuration.
string
The configured webhook URL.
array
The list of subscribed event types.
boolean
Whether the webhook is currently active.
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"
}