Saltar al contenido principal

Documentation Index

Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt

Use this file to discover all available pages before exploring further.

TED IN permite a su institución recibir transferencias de cualquier banco brasileño de forma automática. No se requiere ninguna acción de su equipo — el plugin se encarga de la detección, validación y acreditación. Cuando un cliente de otro banco envía un TED a su institución, los fondos aparecen en la cuenta del destinatario en minutos.

Cómo funciona


  1. Un cliente de otro banco inicia una transferencia TED dirigida a una de las cuentas de su institución
  2. Cada 30 segundos, el plugin consulta la red JD SPB en busca de transferencias entrantes nuevas
  3. La cuenta del destinatario se valida contra su CRM usando el número de documento incluido en el mensaje de transferencia
  4. El monto se acredita automáticamente en la cuenta del destinatario (menos la tarifa de cashin, si está configurada)
Diagrama de flujo TED IN

Cronograma de detección y procesamiento


Lo que experimenta su cliente después de que el banco de origen envía la transferencia:
TiempoQué ocurre
T+0sEl banco de origen envía la transferencia a la red BACEN
T+30sEl plugin detecta la transferencia; el estado pasa a RECEIVED
T+32sSe busca y confirma la cuenta del destinatario; el estado pasa a PROCESSING
T+35sEl monto se acredita en la cuenta del destinatario; el estado pasa a COMPLETED
T+36sSe envía la notificación webhook a su sistema
SLA típico: Menos de 1 minuto desde el momento en que el banco de origen envía la transferencia.

Estados de transferencia


EstadoQué significa para el destinatario
RECEIVEDTransferencia detectada en la red; en proceso
PROCESSINGCuenta del destinatario confirmada; se está aplicando el crédito
COMPLETEDLos fondos han llegado a la cuenta del destinatario
FAILEDNo se pudo identificar al destinatario; fondos devueltos al remitente

Tarifa de recepción (cashin)


Su organización puede opcionalmente cobrar una tarifa sobre las transferencias entrantes. Cuando está habilitada, la tarifa se deduce del monto antes de que se acredite — el destinatario recibe el monto neto. El monto de la tarifa y su configuración se establecen por organización a través del Fees Engine. Fórmula: monto acreditado = monto de transferencia − tarifa Ejemplo: una transferencia de R1.000,00conunatarifadeR1.000,00 con una tarifa de R2,50 resulta en R$997,50 acreditados en la cuenta del destinatario. Esto es lo opuesto a TED OUT, donde la tarifa se suma al monto y el remitente paga más.

Qué ocurre cuando no se encuentra un destinatario


Si el número de documento en la transferencia entrante no puede asociarse a una cuenta en su CRM, la transferencia se devuelve automáticamente al banco de origen. El cliente remitente recupera su dinero. No se requiere intervención manual y no quedan fondos sin contabilizar. El registro de la transferencia se marca como FAILED con el motivo “No se pudo identificar la cuenta del destinatario.”

Consultar transferencias recibidas


Use el endpoint List Transfers para recuperar todas las transferencias entrantes. Filtre por type=TED_IN para ver solo las transferencias recibidas. Endpoint: GET /v1/transfers Respuesta (campos clave):
{
  "items": [
    {
      "transferId": "019c96a0-ab20-7def-a1b2-1f2a3b4c5d6e",
      "type": "TED_IN",
      "status": "COMPLETED",
      "amount": 5000.00,
      "feeAmount": 0.00,
      "totalAmount": 5000.00,
      "createdAt": "2026-01-21T10:15:00-03:00",
      "updatedAt": "2026-01-21T10:15:30-03:00"
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0,
    "returned": 1,
    "totalCount": 150,
    "hasNextPage": true
  }
}
Para opciones completas de parámetros de consulta, consulte la referencia List Transfers.

Endpoints operativos


Dos endpoints de operador controlan el bucle de polling de TED IN. Están diseñados para scripts y runbooks, no para tráfico de usuario final.
EndpointPropósito
POST /v1/transfers/ted-in/pollDispara manualmente el poller de JD que normalmente se ejecuta en un cron de 30s. Útil tras una ventana de incidente o para validar la conectividad con JD. Es tenant-scoped, pero no requiere X-Organization-Id porque el tenant se resuelve desde el contexto autenticado.
POST /v1/transfers/ted-in/replayReprocesa un mensaje TED IN previamente recibido cuyo procesamiento de crédito falló downstream. Requiere X-Organization-Id e idempotencia.
Para el body de la solicitud, la respuesta, los códigos de estado y los códigos de error, consulte la especificación OpenAPI de TED (operaciones triggerTEDInPoller y replayTEDInPoller).

Tres caminos distintos de dead-letter


El plugin utiliza tres almacenes de fallas separados. No son intercambiables y deben monitorearse de forma independiente:
  • JD parse failures — almacenadas en jd_incoming_parse_failures. El mensaje llegó desde JD pero no pudo ser interpretado (XML mal formado, tipo de mensaje desconocido). Requiere triaje manual.
  • Transferencias entrantes no entregables — almacenadas en undeliverable_incoming_transfers. El parseo fue exitoso, pero el crédito no pudo aplicarse (p. ej., cuenta del destinatario no encontrada). Puede generar una devolución automática al banco de origen.
  • Webhook DLQ — la cola de reintentos para entregas de webhook salientes fallidas, expuesta vía /v1/transfers/webhooks/dlq. No relacionada con la ingesta de TED IN; este es el canal de eventos saliente hacia los clientes integradores.

Webhooks


Configure un webhook para recibir notificaciones en tiempo real cuando lleguen transferencias. El evento transfer.incoming.completed se activa en cuanto se acredita una transferencia. Consulte Webhooks para detalles de configuración y del payload del evento.

Conciliación


Para la conciliación contable y financiera, cada registro de transferencia incluye los siguientes campos:
CampoUso
controlNumberNúmero de control JD SPB — único por transferencia, usado para la conciliación interbancaria
transferIdIdentificador interno de Lerian
createdAtMarca de tiempo de cuando se detectó la transferencia
completedAtMarca de tiempo de cuando se acreditaron los fondos
El historial de transferencias se conserva durante 5 años, según lo exigen las regulaciones de BACEN.

Garantías de procesamiento


El plugin está diseñado para que ninguna transferencia se pierda y ninguna se acredite dos veces:
  • Sin créditos duplicados — cada mensaje de transferencia lleva un número de secuencia único; el plugin rechaza cualquier intento de procesar el mismo mensaje más de una vez
  • Reintento automático en caso de falla — los errores transitorios (como una interrupción momentánea del servicio) se reintentan con retroceso exponencial antes de registrar cualquier estado de falla
  • Cola de mensajes no procesables — si una transferencia no puede procesarse después de todos los reintentos, se mueve a una cola de mensajes no procesables para revisión manual, asegurando que nada se descarte silenciosamente