API Pay-In
La API Pay-In de Cashela te permite cobrar a tus clientes con los métodos de pago que usan a diario: transferencias bancarias, vouchers en efectivo, dinero móvil y tarjetas. Creas un depósito, tu cliente lo paga y Cashela te envía una notificación firmada con el resultado y acredita el importe neto en tu cuenta Cashela.
Cómo funciona
- Consulta los países donde puedes cobrar y con qué tipos de pago.
- Consulta los métodos de pago para un país y un importe. Cada método trae sus comisiones, el total que paga tu cliente, lo que se te acredita y los campos del cliente que debes enviar.
- Crea un depósito con el
payment_methodelegido y los datos del cliente. La respuesta te dice cómo paga tu cliente: normalmente un enlace a una página de pago alojada por Cashela, o instrucciones de pago. - Recibe la notificación en tu
notification_urlcuando el depósito llega a un estado final, y consulta el depósito cuando quieras con Consultar un depósito.
Consulta el Flujo de integración para ver la secuencia completa.
Entornos
Toda integración empieza en sandbox y pasa a producción cuando Cashela aprueba tu solicitud de go-live. Cada entorno tiene sus propias credenciales: las de sandbox nunca funcionan en producción, y las de producción nunca funcionan en sandbox.
| Entorno | Base URL | Dinero real |
|---|---|---|
| Sandbox | https://sandbox-api.cashela.com | No |
| Producción | https://production-api.cashela.com | Sí |
Todas las peticiones y respuestas son JSON sobre HTTPS. Todos los endpoints están bajo /api/v1/pay-in/.
Endpoints
| Método | Ruta | Qué hace |
|---|---|---|
GET | /api/v1/pay-in/deposit-creation/countries | Países y tipos de pago disponibles para tu cuenta |
POST | /api/v1/pay-in/deposit-creation/available-payment-methods | Métodos de pago para un país e importe, con comisiones y campos obligatorios del cliente |
POST | /api/v1/pay-in/deposit-creation/exchange-rates | Tasa de cambio indicativa para un país y tipo de pago |
POST | /api/v1/pay-in/deposit-creation | Crea un depósito. Mueve dinero. |
GET | /api/v1/pay-in/transactions/{reference} | Consulta un depósito y su estado |
POST | /api/v1/pay-in/transactions/{reference}/callback | Reenvía la notificación de un depósito final |
POST | /api/v1/pay-in/transactions/{reference}/void | Anula un depósito con tarjeta antes de que se liquide. Mueve dinero. |
POST | /api/v1/pay-in/transactions/{reference}/refund | Reembolsa un depósito con tarjeta, total o parcialmente. Mueve dinero. |
POST | /api/v1/pay-in/sandbox/transactions/{reference}/simulate | Solo sandbox. Lleva un depósito a un estado final |
Antes de empezar
Necesitas:
- Una cuenta Cashela Business verificada. Regístrate en cashela.com/business-home.
- Un servidor con HTTPS que pueda guardar un secreto y recibir notificaciones (webhooks).
Después sigue Primeros pasos para abrir el Portal de Desarrolladores y crear tu clave API de sandbox.
Ideas clave
- Manda el catálogo. Los países, métodos de pago, comisiones y campos obligatorios dependen del país, del importe, de tu cuenta y del entorno. No fijes códigos de método en tu código: consulta Obtener métodos de pago antes de cada depósito.
- Solo en tu servidor. Tu
api_secretautentica tus peticiones y además firma las notificaciones que te envía Cashela. Nunca lo pongas en un navegador ni en una app móvil. - Reintentos seguros. Cada depósito lleva tu propio
external_identifierúnico. Repetir una petición nunca crea un segundo depósito. Ver Idempotencia. - Verifica cada notificación. Comprueba la cabecera
X-Cashela-Signatureantes de confiar en una notificación. Ver Webhooks. - Producción es más estricta que sandbox. Producción valida con más rigor teléfonos, documentos y correos. Prueba con datos realistas del país del depósito. Ver Datos del pagador y documentos.
Soporte
Cuando contactes con el soporte de Cashela por una petición, incluye la cabecera X-Trace-Id que enviaste con ella y la reference del depósito. Ver Autenticación.