¿Qué vas a lograr?
Al terminar esta guía podrás crear cobros y enviarlos a tus clientes por múltiples canales. Todo se hace con un solo endpoint (POST /payments), y el canal de entrega depende de los campos que envíes.
Prerrequisitos
- Cuenta de OnePay creada y verificada
- Llaves de API generadas (ver cómo)
- Webhooks configurados (ver cómo)
¿Qué canal necesitas?
Para ver ejemplos detallados de cada caso, consulta los Casos de uso de cobros.
Diagrama de flujo
Paso a paso
1
Crear la solicitud de cobro
Usa
POST /payments con los campos que necesites según el canal de entrega:- WhatsApp
- Email
- Link manual
- Monto abierto
- Portal de pagos
2
Obtener el link de pago
En la respuesta recibirás un objeto con el
payment_link:- Si enviaste
phone: el cliente recibe el link automáticamente por WhatsApp. - Si enviaste
email: el cliente recibe el link por correo electrónico. - Si enviaste
reference: el cliente puede buscar el cobro en el portal de pagos. - Si no enviaste ninguno: copia
payment_linky compártelo manualmente.
3
El cliente completa el pago
Al abrir el link, el cliente verá una página de pago con los métodos habilitados. Si el link es de monto abierto, el cliente ingresará el monto antes de pagar.
4
Recibe la notificación por webhook
Cuando el pago se complete, recibirás un webhook
payment.approved:Opciones adicionales
Configurar métodos de pago
Usa el campoallows para controlar qué métodos de pago estarán disponibles en el link:
Establecer fecha de expiración
Redireccionar después del pago
Errores comunes
Siguiente paso
Todos los casos de uso
Revisa la referencia completa de cada caso de uso de cobros.
Cobrar con débito directo
Debita automáticamente tarjetas o cuentas bancarias autorizadas.