Documento t茅cnico para M茅xico 馃嚥馃嚱

Cargos recurrentes automatizados a cuentas bancarias . Recibe pagos recurrentes sin necesidad de tarjetas de cr茅dito o d茅bito.

A continuaci贸n se especificar谩 como implementar el servicio de Domiciliaci贸n con el funcionamiento b谩sico, existen personalizaciones las cuales se detallan en caracter铆sticas de personalizaci贸n adicionales

Resumen del proceso

Al momento que un cliente decide domiciliar mediante ETpay, se ejecuta un flujo que se resume de la siguiente forma:

  1. CREAR SESI脫N Desde la p谩gina web del merchant, se genera una solicitud POST a nuestra API para obtener el session_token que permite al usuario iniciar su sesi贸n de la suscripci贸n.
  2. INICIAR FUNNEL Desde la p谩gina web del merchant, se env铆a un correo al usuario con el enlace al proceso de suscripci贸n.
  3. SESI脫N DEL CLIENTE (FUNNEL) Proceso que realiza el usuario que requiere suscribirse, ingresando datos personales y firmando la autorizaci贸n de cargos recurrentes.
  4. REDIRECCI脫N El usuario realiza su sesi贸n de suscripci贸n en nuestro funnel. Al completar la suscripci贸n el funnel redireccionar谩 a la URL de 茅xito o error seg煤n corresponda (ambas pueden ser la misma URL). Esta redirecci贸n tiene solamente el fin de dar una confirmaci贸n visual al usuario final dentro del sitio del merchant.
  5. RECEPCI脫N DE NOTIFICACI脫N ETpay realizar谩 una solicitud POST a la URL del servicio web especificado por el merchant. Esta llamada confirma el estado exitoso o fallido de la suscripci贸n y requiere de un paso de validaci贸n de la informaci贸n.

Definiciones

Nombre del campo Descripci贸n Opcional Tipo de dato
merchant_code El c贸digo de identificaci贸n del merchant No Cadena
merchant_api_token El API token 煤nico del merchant No Cadena
client_full_name El nombre completo del cliente a domiciliar No Cadena
client_id El identificador 煤nico del cliente de cara al merchant No Cadena
merchant_order_id El identificador 煤nico de la domiciliaci贸n de cara al merchant No Cadena
client_email El email del cliente al que se le debe de mandar los correos de suscripci贸n No Cadena
service_name El nombre del servicio al que el cliente se va suscribir No Cadena
service_id El identificador 煤nico del servicio al que el cliente se va a suscribir No Cadena
max_amount El monto m谩ximo que se le puede llegar a cobrar a un cliente en una solicitud de cobro S铆 N煤mero
frequency La frecuencia con la que se pueden hacer cobros (weekly, biweekly, monthly, bimonthly, by_use) S铆 Cadena
end_date La 煤ltima fecha en la que se le podr谩 hacer un cobro al cliente (YYYY-MM-DD) S铆 Cadena
subscription_completed_url La URL a la que se le debe de hacer la redirecci贸n al cliente al completar su suscripci贸n S铆 Cadena
subscription_cancelation_url La URL a la que se le debe de hacer la redirecci贸n al cliente cuando haya un error en su proceso de suscripci贸n S铆 Cadena

El siguiente es el cat谩logo aceptado de frecuencias de pago para el campo frequency :

FREQUENCY SIGNIFICADO
weekly La domiciliaci贸n a crear debe de aceptar cobros semanales
biweekly La domiciliaci贸n a crear debe de aceptar cobros quincenales
monthly La domiciliaci贸n debe de aceptar cobros mensuales
bimonthly La domiciliaci贸n debe de aceptar cobros bimestrales
by_use [DEFAULT] La domiciliaci贸n acepta cobros en cualquier otra frecuencia