Optimiza tus pagos de salida de una forma rápida, guiada y completamente automatizada.

<aside> ⚠️

Este producto es altamente sensible, ya que corresponde a la salida de dinero. Por este motivo, recomendamos mantener altos estándares de seguridad y recordar siempre que todas las credenciales deben permanecer bajo estricto resguardo y no deben ser compartidas por ningún canal de comunicación.

En caso de que alguna credencial se vea expuesta o exista sospecha de compromiso, se recomienda comunicarse de inmediato con nuestro equipo de soporte al correo [email protected] y efectuar el cambio de credenciales.

</aside>

Resumen del flujo

  1. **REALIZAR LOGIN** Comenzamos realizando login mediante la ruta de autenticación de la api, esto te permitirá conseguir un token de autorización necesario para interactuar con el resto de funciones.
  2. **GENERAR PAYOUT** Indicamos los campos de la cuenta a la cual se realizará el Payout, posterior a eso recibiremos respuesta inmediata de la API confirmando si la petición se realizó/procesó de forma exitosa.
  3. PROCESAR NOTIFICACIÓN WEBHOOK Procesamos la notificación de estado final de cada Payout de forma individual, en este paso debes levantar una API para procesado asíncrono (webhook). Paso obligatorio para obtener la aprobación de los Payouts.

Opciones adicionales

  1. **CONSULTAR SALDO DE CUENTA** Puedes consultar el balance de la cuenta en todo momento, considera revisar el saldo actual previo a realizar un Payout “masivo”.
  2. **CONSULTAR ESTADO DE UN PAYOUT** Puedes consultar el estado actual de un Payout mediante su identificador único, esto te permitirá consultar o actualizar el estado frente a dudas, sin embargo, este método no debe ser nunca el principal de actualización de estados de Payout.
  3. CONSULTAR PAYOUTS POR RANGO DE FECHA Puedes consultar el estado de todos tus Payouts en un rango de fechas determinadas definidas durante la consulta a la API.
  4. CÓDIGOS DE ERROR El equipo de integraciones de etpay puede configurar tu perfil con esta característica, los códigos de error de payouts son una forma más simple de mapear errores.

Definiciones:

Parámetro Descripción
merchant_code El código único de identificación de comercio, variará entre ambientes sandbox y productivo. Entregado por ETpay al momento de iniciar la cadena de comunicaciones para la integración.
merchant_api_token El token de autenticación para el uso de la api, variará entre ambientes sandbox Y productivo. Entregado por ETpay al momento de iniciar la cadena de comunicaciones para la integración.
username El usuario corresponde al correo electrónico informado durante el proceso de Onboarding, este usuario quedará definido como el propietario de la cuenta y será quien tenga la posibilidad de ejecutar los Payouts.
password La contraseña se generara al recibir la invitación para unirse a plataforma (es importante recordar, que no se debe compartir dicha contraseña)
api_url la URL de la api de servicios e inicio de sesión, variará entre ambientes sandbox y productivo. Entregado por ETpay al momento de iniciar la cadena de comunicaciones para la integración.
authorization_token El token de autorización permitira la correcta validación del usuario que este intentando realizar los payouts.

Flujo Base

1. Login

Para comenzar, debes realizar un inicio de sesión, con eso podrás hacer uso del servicio de payouts, esto con el fin de brindar una mayor seguridad a la hora de hacer movimientos de dinero.

Deberás realizar POST al endpoint detallado a continuación: