Métodos de pago
Recaudo
Dispersiones
Webhooks
Fintech as a service
Crear webhook
Copy
curl --request POST \
--url https://api.onepay.la/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"url": "<string>",
"events": [
{}
]
}
'Copy
{
"data": {
"id": "9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
"name": "Notificaciones de Pagos",
"description": "Webhook para recibir eventos de pagos aprobados y rechazados",
"url": "https://mi-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
],
"secret": "wh_tok_j8K3mN9pQ2rS5tU7vX0yZ1aB4cD6eF8gH0iJ2kL4mN6",
"header": "wh_hdr_A1bC3dE5fG7hI9jK1lM3nO5pQ7rS9tU1vW3xY5zA7",
"is_test": false,
"created_at": "2025-02-09T16:30:00.000000Z",
"updated_at": "2025-02-09T16:30:00.000000Z"
}
}
POST
https://api.onepay.la/v1
/
webhooks
Crear webhook
Copy
curl --request POST \
--url https://api.onepay.la/v1/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"url": "<string>",
"events": [
{}
]
}
'Copy
{
"data": {
"id": "9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
"name": "Notificaciones de Pagos",
"description": "Webhook para recibir eventos de pagos aprobados y rechazados",
"url": "https://mi-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
],
"secret": "wh_tok_j8K3mN9pQ2rS5tU7vX0yZ1aB4cD6eF8gH0iJ2kL4mN6",
"header": "wh_hdr_A1bC3dE5fG7hI9jK1lM3nO5pQ7rS9tU1vW3xY5zA7",
"is_test": false,
"created_at": "2025-02-09T16:30:00.000000Z",
"updated_at": "2025-02-09T16:30:00.000000Z"
}
}
Crea un nuevo webhook para recibir notificaciones en tiempo real sobre eventos en tu cuenta.
Body
Nombre descriptivo del webhook (máximo 255 caracteres)
Descripción opcional del webhook (máximo 500 caracteres)
URL HTTPS donde OnePay enviará las notificaciones (máximo 500 caracteres)
Lista de eventos que deseas recibir. Debes incluir al menos un evento. Solo se aceptan eventos válidos definidos en el sistema.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.
Ejemplos de uso
- curl
- JavaScript
- Python
Copy
curl https://api.onepay.la/v1/webhooks \
-X POST \
-H "Authorization: Bearer sk_test_xxx" \
-H "Content-Type: application/json" \
-d '{
"name": "Notificaciones de Pagos",
"description": "Webhook para recibir eventos de pagos aprobados y rechazados",
"url": "https://mi-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
]
}'
Copy
import fetch from 'node-fetch';
const body = {
name: 'Notificaciones de Pagos',
description: 'Webhook para recibir eventos de pagos aprobados y rechazados',
url: 'https://mi-servidor.com/webhooks/onepay',
events: [
'payment.approved',
'payment.rejected',
'payment.expired'
]
};
const response = await fetch('https://api.onepay.la/v1/webhooks', {
method: 'POST',
headers: {
Authorization: 'Bearer sk_test_xxx',
'Content-Type': 'application/json'
},
body: JSON.stringify(body)
});
const webhook = await response.json();
console.log(webhook);
Copy
import requests
payload = {
"name": "Notificaciones de Pagos",
"description": "Webhook para recibir eventos de pagos aprobados y rechazados",
"url": "https://mi-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
]
}
response = requests.post(
"https://api.onepay.la/v1/webhooks",
headers={
"Authorization": "Bearer sk_test_xxx",
"Content-Type": "application/json"
},
json=payload,
timeout=15
)
response.raise_for_status()
print(response.json())
Response
Datos del webhook creado
Show data properties
Show data properties
Identificador único del webhook (UUID)
Nombre del webhook
Descripción del webhook
URL donde se enviarán las notificaciones
Lista de eventos suscritos
Token secreto para validar la firma HMAC-SHA256 de las notificaciones. Guarda este valor de forma segura, lo necesitarás para verificar que las notificaciones provienen de OnePay.
Token que se incluye en el header
x-webhook-token de cada notificaciónFecha y hora de creación en formato ISO 8601
Ejemplo de respuesta
Copy
{
"data": {
"id": "9e5ccd4a-d2f0-49dd-87fc-a0da752bd166",
"name": "Notificaciones de Pagos",
"description": "Webhook para recibir eventos de pagos aprobados y rechazados",
"url": "https://mi-servidor.com/webhooks/onepay",
"events": [
"payment.approved",
"payment.rejected",
"payment.expired"
],
"secret": "wh_tok_j8K3mN9pQ2rS5tU7vX0yZ1aB4cD6eF8gH0iJ2kL4mN6",
"header": "wh_hdr_A1bC3dE5fG7hI9jK1lM3nO5pQ7rS9tU1vW3xY5zA7",
"is_test": false,
"created_at": "2025-02-09T16:30:00.000000Z",
"updated_at": "2025-02-09T16:30:00.000000Z"
}
}
Importante sobre el secret: El token
secret se genera automáticamente y solo se muestra una vez al crear el webhook. Úsalo para validar la firma HMAC-SHA256 en el header x-signature de cada notificación y así verificar que proviene de OnePay.Una vez creado el webhook, OnePay comenzará a enviar notificaciones a la URL configurada cuando ocurran los eventos seleccionados. Asegúrate de implementar la validación de firma para garantizar la seguridad de tu integración.
Was this page helpful?