Skip to main content
La vista de gestión de adhesiones deja que tu usuario final administre su domiciliación (autopay) embebida en tu sitio, sin entrar al portal completo. Desde ahí puede:

Ver

Los medios que tiene adheridos: tarjeta o cuenta CLABE.

Adherir

Un medio nuevo, cuando todavía no tiene ninguno.

Desadherir

Un medio existente.
Usa el mismo SDK que el widget de medios de pago: misma instalación, mismas opciones de identificación de empresa y mismo destroy(). Las dos diferencias son que se monta con view: "autopay" y que emite sus propios eventos.
La instalación, los entrypoints, loadTapipay() y el entorno de homologación son idénticos. Están en SDK de medios de pago.

Uso rápido

Igual que en el widget de pago, puedes identificar tu empresa con organization (el slug) o con companyCode. Reemplaza organization: "acme-corp" por companyCode: "MX-S-12345" en cualquiera de los ejemplos.

La opción view

El resto de las opciones (container, organization / companyCode, identifier, environment) son las mismas que en la vista de pagos. externalRequestId y selectionStrategy no aplican aquí: son de la vista de pagos. La URL que monta el SDK es la misma de la vista de pagos con /autopay al final:

Eventos

Privacidad. Los eventos de adhesiones exponen solo lo mínimo: el tipo de medio (mediaType) y los últimos 4 dígitos (lastFour). El id es un hash opaco, no el identificador interno. Nunca se exponen el titular, el número o CLABE completos, la marca, el banco ni tokens.

Payloads

mediaType distingue el medio adherido: card es tarjeta de crédito, bank_account es cuenta CLABE y debit_card es tarjeta de débito.

En React

autopayLoaded se reinvoca cada vez que la lista cambia, así que te sirve como única fuente para tu contador de medios adheridos: no necesitas sumar y restar a mano con autopayActivated y autopayRemoved.

Eventos del alta de domiciliación

Cuando el usuario todavía no tiene un medio adherido, la vista autopay abre el flujo de alta de domiciliación dentro del mismo iframe. Ese flujo emite sus propios eventos, uno por cada paso que el usuario completa, para que puedas seguir su avance desde tu sitio.
Son hitos de la interfaz: te dicen lo que el usuario completó en el widget, no lo que confirmó el backend. La adhesión se procesa de forma asíncrona, así que la confirmación de que quedó activa llega por autopayActivated.
Los primeros cuatro forman una secuencia. Se disparan una sola vez cada uno, en este orden:
1

domiciliationBankSelected

El usuario eligió su banco.
2

domiciliationFormCompleted

Los datos de la cuenta pasaron la validación del backend.
3

domiciliationVerificationCompleted

La verificación de la cuenta concluyó.
4

domiciliationConfirmed

El usuario confirmó la adhesión.
El quinto, domiciliationAccountCheckFailed, no forma parte de esa secuencia: es un evento de error que puede dispararse cero, una o muchas veces mientras el usuario escribe su CLABE o tarjeta. Es el equivalente de autopayError para este flujo.
Debajo, estos eventos son mensajes postMessage que emite el iframe. Si lo embebes a mano, sin el SDK, puedes escucharlos directo: ver Eventos postMessage.
Privacidad. A diferencia de los eventos de adhesiones, aquí sí viaja la identidad del banco (bankId, speiCode, name), porque tú embebes el widget para tus propios clientes. Lo que nunca viaja son los datos del titular ni la cuenta completa: ni el nombre, ni el correo, ni el RFC, ni la CLABE o tarjeta completas, ni tokens. De la cuenta solo salen el tipo (accountType) y los últimos 4 dígitos (lastFour).

Payloads

Motivos de domiciliationAccountCheckFailed

Nunca viaja la CLABE o tarjeta que el usuario escribió, ni el mensaje de error que ve en pantalla (ese texto es de la interfaz y puede cambiar sin aviso). Solo el banco seleccionado y el motivo categorizado.

En React

Para medir dónde abandonan tus usuarios, registra los cuatro hitos en orden y compara cuántos llegan a cada uno. domiciliationAccountCheckFailed te dice, además, con qué dato se traban antes de poder avanzar.

Cómo se relaciona con la API

Una suscripción creada con autopay: true se cobra por domiciliación, sin que el usuario elija un medio en cada cobro. En débito automático (POST /v2/debts) la deuda no lleva autopay: se debita sola si referencia un producto y el usuario tiene un medio por defecto adherido. Para que ese cobro funcione, el usuario tiene que tener un medio adherido: esta pantalla es donde lo adhiere.

Medios de pago y domiciliación

Cómo funciona autopay en deudas y suscripciones, y su relación con paymentMethods.