Métodos de pago
Recaudo
Dispersiones
Webhooks
Fintech as a service
Actualizar webhook
Copy
curl --request PUT \
--url https://api.onepay.la/v1/webhooks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"url": "<string>",
"events": [
{}
]
}
'Copy
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Notificaciones Actualizadas",
"description": "Nueva descripción del webhook",
"url": "https://nuevo-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
],
"header": "wh_hdr_abc123...",
"is_test": false,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-09T16:20:00Z"
}
}
PUT
https://api.onepay.la/v1
/
webhooks
/
{id}
Actualizar webhook
Copy
curl --request PUT \
--url https://api.onepay.la/v1/webhooks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"url": "<string>",
"events": [
{}
]
}
'Copy
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Notificaciones Actualizadas",
"description": "Nueva descripción del webhook",
"url": "https://nuevo-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
],
"header": "wh_hdr_abc123...",
"is_test": false,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-09T16:20:00Z"
}
}
Actualiza la configuración de un webhook existente. Puedes actualizar uno o más campos de forma independiente.
Path Parameters
ID del webhook (UUID)
Body
Nombre descriptivo del webhook (máximo 255 caracteres)
Descripción del webhook (máximo 500 caracteres). Puedes enviar
null para eliminar la descripción.URL HTTPS donde OnePay enviará las notificaciones (máximo 500 caracteres)
Lista de eventos que deseas recibir. Debes incluir al menos un evento si envías este campo.Eventos de Pagos (Cobros):
payment.created- Cobro creadopayment.approved- Cobro aprobadopayment.rejected- Cobro rechazadopayment.expired- Cobro expirado
charge.created- Cargo creadocharge.succeeded- Cargo exitosocharge.failed- Cargo fallido
cashout.created- Dispersión creadacashout.approved- Dispersión aprobadacashout.rejected- Dispersión rechazada
subscription.created- Suscripción creadasubscription.active- Suscripción activasubscription.cancelled- Suscripción cancelada
account.validated- Cuenta validadaaccount.failed- Validación de cuenta fallida
Si envías un evento que no está en la lista anterior, recibirás un error de validación 422.
Response
Datos actualizados del webhook
Show Propiedades del webhook
Show Propiedades del webhook
Identificador único del webhook (UUID)
Nombre descriptivo del webhook
Descripción del webhook (puede ser null)
URL donde se envían las notificaciones
Lista de eventos suscritos
Token de header para autenticación del webhook
Indica si es un webhook de prueba
Fecha de creación en formato ISO 8601
Fecha de última actualización en formato ISO 8601
Ejemplos de uso
- curl
- JavaScript
- Python
Copy
# Actualización completa
curl https://api.onepay.la/v1/webhooks/550e8400-e29b-41d4-a716-446655440000 \
-X PUT \
-H "Authorization: Bearer sk_test_xxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Notificaciones Actualizadas",
"description": "Nueva descripción del webhook",
"url": "https://nuevo-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
]
}'
Copy
# Actualización parcial (solo nombre)
curl https://api.onepay.la/v1/webhooks/550e8400-e29b-41d4-a716-446655440000 \
-X PUT \
-H "Authorization: Bearer sk_test_xxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Nuevo Nombre del Webhook"
}'
Copy
import fetch from 'node-fetch';
const webhookId = '550e8400-e29b-41d4-a716-446655440000';
// Actualización completa
const body = {
name: 'Notificaciones Actualizadas',
description: 'Nueva descripción del webhook',
url: 'https://nuevo-servidor.com/webhooks/onepay',
events: [
'payment.approved',
'payment.rejected',
'payment.expired'
]
};
const response = await fetch(`https://api.onepay.la/v1/webhooks/${webhookId}`, {
method: 'PUT',
headers: {
Authorization: 'Bearer sk_test_xxx',
'Content-Type': 'application/json'
},
body: JSON.stringify(body)
});
const data = await response.json();
console.log(data);
Copy
// Actualización parcial (solo URL)
const partialUpdate = {
url: 'https://nuevo-servidor.com/webhooks/onepay'
};
const response = await fetch(`https://api.onepay.la/v1/webhooks/${webhookId}`, {
method: 'PUT',
headers: {
Authorization: 'Bearer sk_test_xxx',
'Content-Type': 'application/json'
},
body: JSON.stringify(partialUpdate)
});
Copy
import requests
webhook_id = '550e8400-e29b-41d4-a716-446655440000'
# Actualización completa
body = {
'name': 'Notificaciones Actualizadas',
'description': 'Nueva descripción del webhook',
'url': 'https://nuevo-servidor.com/webhooks/onepay',
'events': [
'payment.approved',
'payment.rejected',
'payment.expired'
]
}
headers = {
'Authorization': 'Bearer sk_test_xxx',
'Content-Type': 'application/json'
}
response = requests.put(
f'https://api.onepay.la/v1/webhooks/{webhook_id}',
json=body,
headers=headers
)
data = response.json()
print(data)
Copy
# Actualización parcial (solo eventos)
partial_update = {
'events': ['charge.paid', 'charge.failed']
}
response = requests.put(
f'https://api.onepay.la/v1/webhooks/{webhook_id}',
json=partial_update,
headers=headers
)
Ejemplo de respuesta
Copy
{
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Notificaciones Actualizadas",
"description": "Nueva descripción del webhook",
"url": "https://nuevo-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
],
"header": "wh_hdr_abc123...",
"is_test": false,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-02-09T16:20:00Z"
}
}
Puedes actualizar solo los campos que necesites cambiar. Los campos no incluidos en la petición mantendrán sus valores actuales.
- Solo puedes actualizar webhooks de tu propia empresa
- La URL debe ser una URL válida con protocolo HTTPS
- Si actualizas los eventos, debes incluir al menos un evento válido
- Todos los cambios quedan registrados en el historial de auditoría del webhook
Was this page helpful?