Tarjetas guardadas y cobros masivos

Irreversible

Qué cubre#

Este grupo trabaja con las tarjetas que los clientes del comercio ya autorizaron guardar (tokenización) y con los cobros masivos a esas tarjetas.

Cómo funciona el guardado: el agente genera un enlace seguro y lo comparte con el cliente; el cliente digita ahí su tarjeta. Ni el agente, ni el modelo, ni el comercio ven el número completo: las herramientas de consulta devuelven la marca y los últimos dígitos.

Las operaciones sensibles del grupo —cobrar a una tarjeta guardada, eliminar una tarjeta y crear cobros masivos— exigen un código de confirmación que llega al correo del comercio.

Las rutas del API que usan los cobros masivos quedan fuera de la referencia del portal, así que estas páginas no las publican. Lo que sí queda documentado es qué hace cada herramienta, qué recibe y qué devuelve.

Herramientas#

Listar grupos de cobro

Sólo lectura

tilopay_saved_cards_list_groups

Lista los grupos de cobro con tarjetas almacenadas (afiliados) en Tilopay.

Parámetros

Sin parámetros.

Devuelve

{ result }

Respuesta cruda del API de Tilopay bajo la llave `result`.

Listar afiliados con tarjeta almacenada

Sólo lectura

tilopay_saved_cards_list_affiliates

Lista los afiliados (clientes con tarjeta almacenada) de un grupo de cobro.

Parámetros

ParámetroTipoObligatorioDescripción
groupintegerID del grupo (0 para todos)

Devuelve

{ result }

Respuesta cruda del API de Tilopay bajo la llave `result`.

Listar cobros masivos

Sólo lectura

tilopay_saved_cards_list_collections

Lista los cobros masivos realizados con tarjetas almacenadas en Tilopay.

Parámetros

Sin parámetros.

Devuelve

{ result }

Respuesta cruda del API de Tilopay bajo la llave `result`.

Detalle de un cobro masivo

Sólo lectura

tilopay_saved_cards_collection_detail

Obtiene el detalle de un cobro masivo. Requiere el `code` del cobro (campo `code` devuelto por tilopay_saved_cards_list_collections).

Parámetros

ParámetroTipoObligatorioDescripción
codestringCódigo del cobro masivo (campo `code` de la lista de cobros)

Devuelve

{ result }

Respuesta cruda del API de Tilopay bajo la llave `result`.

Guardar la tarjeta de un cliente (tokenizar)

Escritura

tilopay_tokenize_card

Genera el enlace seguro de Tilopay donde el cliente ingresa su tarjeta para dejarla guardada (tokenizada). El comercio nunca ve ni recibe los datos de la tarjeta. Una vez guardada, se le puede cobrar con tilopay_saved_cards_create_payments (esa sí pide código de confirmación por correo). Si se indica un contacto o teléfono, también devuelve un enlace de WhatsApp con el mensaje listo para enviarle al cliente.

Operación del API: POST /api/v1/processTokenize

Parámetros

ParámetroTipoObligatorioDescripción
emailstringCorreo del tarjetahabiente
first_namestringNombre del tarjetahabiente
last_namestringApellido del tarjetahabiente
languagestring (es | en)Idioma del formulario (es por defecto)
redirect_urlstringURL a la que vuelve el cliente al terminar (opcional)
contact_namestringNombre del contacto guardado o del cliente, para armar el mensaje de WhatsApp
phonestringTeléfono de WhatsApp del cliente, ej. +50688887777
messagestringTexto propio para el mensaje al cliente
save_contactbooleanGuardar el contacto en la agenda

Devuelve

{ tokenize_url, whatsapp_url, email, contact }

tokenize_url = enlace seguro donde el cliente ingresa su tarjeta para guardarla; whatsapp_url = enlace de WhatsApp listo para enviárselo. La tarjeta la digita el cliente: el agente nunca recibe el número.

Listar las tarjetas guardadas de un cliente

Sólo lectura

tilopay_list_customer_cards

Lista las tarjetas que un cliente ya tiene guardadas (tokenizadas) en Tilopay, identificadas por su correo. Devuelve el token de cada tarjeta, que es lo que necesita tilopay_charge_saved_card para cobrarle. Solo se pueden cobrar tarjetas guardadas con el enlace de este asistente o del MCP. No cobra nada.

Parámetros

ParámetroTipoObligatorioDescripción
emailstringCorreo del cliente dueño de las tarjetas
currencystringMoneda de referencia, ej. CRC o USD. Si se omite se usa la del país del comercio.

Devuelve

{ cards, count }

cards = tarjetas ya guardadas de ese cliente, con marca, últimos dígitos y su identificador para cobrar; count = cuántas hay. Nunca devuelve el número completo de la tarjeta.

Métodos de pago disponibles y cuotas

Sólo lectura

tilopay_payment_methods

Lista los métodos de pago habilitados para el comercio en el checkout de Tilopay (tarjetas, SINPE Móvil, Yappy, cuotas o tasa cero cuando están activos) y si la cuenta responde en producción o en pruebas. Úsala cuando el comercio pregunte qué puede ofrecerle a su cliente o si tiene cuotas / tasa cero.

Parámetros

ParámetroTipoObligatorioDescripción
amountnumberMonto de referencia; algunos métodos y cuotas dependen del monto
currencystringMoneda de referencia. Si se omite se usa la del país del comercio.
emailstringCorreo del cliente (opcional; solo para ver también sus tarjetas guardadas)

Devuelve

{ methods, installments, cards, environment, currency }

methods = métodos de pago habilitados para el comercio; installments = cuotas disponibles cuando el método las admite; cards = tarjetas guardadas del cliente si se envió su correo; environment = production o test.

Cobrar a una tarjeta guardada de un cliente

Sensible

tilopay_charge_saved_card

Cobra un monto a una tarjeta ya guardada (tokenizada) de un cliente. Requiere el correo del cliente y el token de la tarjeta (se obtiene con tilopay_list_customer_cards). Operación sensible: mueve dinero real y requiere segundo factor. Llámela primero sin `confirmation_code`: se envía un código de 6 dígitos al correo del comercio y la respuesta trae `requires_confirmation`. Repita la misma llamada, con los mismos parámetros, agregando `confirmation_code`.

Operación del API: POST /api/v1/processRecurrentPayment

Parámetros

ParámetroTipoObligatorioDescripción
emailstringCorreo del tarjetahabiente
cardstringToken de la tarjeta guardada (versión v2)
amountnumberMonto a cobrar
currencystringMoneda del cobro. Si se omite se usa la del país del comercio.
order_numberstringNúmero de orden; si se omite se genera uno único
capturebooleanCapturar de inmediato (por defecto true)
confirmation_codestringCódigo de 6 dígitos recibido por correo para autorizar la operación

Devuelve

{ result, approved, orderNumber, currency, receipt_code, receipt_url, receipt_image_url }

Cobra a una tarjeta ya guardada del cliente: approved = si el cobro fue aprobado; orderNumber = número de orden generado; receipt_* = comprobante del cobro cuando se generó. Exige segundo factor por correo.

Eliminar una tarjeta guardada de un cliente

Sensible

tilopay_remove_saved_card

Elimina una tarjeta guardada (token) de un cliente en Tilopay. Operación sensible: requiere segundo factor. Llámela primero sin `confirmation_code` y repítala luego con el código de 6 dígitos que llega al correo del comercio.

Operación del API: POST /api/v1/user/card-remove

Parámetros

ParámetroTipoObligatorioDescripción
emailstringCorreo del cliente dueño de la tarjeta
tokenstringToken de la tarjeta a eliminar
confirmation_codestringCódigo de 6 dígitos recibido por correo para autorizar la operación

Devuelve

{ result }

result = respuesta del API al eliminar la tarjeta guardada del cliente. Exige segundo factor por correo.

Cobrar a tarjetas almacenadas

Sensible

tilopay_saved_cards_create_payments

Crea cobros a afiliados y/o grupos con tarjetas almacenadas en Tilopay. Solo se permiten afiliados cuya tarjeta se guardó con el enlace de este asistente o del MCP (tilopay_tokenize_card); los demás se rechazan. Operación sensible: afecta dinero real y requiere segundo factor. Llámela primero sin `confirmation_code`: se envía un código de 6 dígitos al correo del comercio y la respuesta trae `requires_confirmation`. Repita la misma llamada, con los mismos parámetros, agregando `confirmation_code`.

Parámetros

ParámetroTipoObligatorioDescripción
reasonstringMotivo del cobro, ej. "Cobro mensualidad"
capturebooleanCapturar de inmediato (por defecto true)
usersarray<object>Afiliados individuales a cobrar
groupsarray<object>Grupos a cobrar
confirmation_codestringCódigo de 6 dígitos recibido por correo para autorizar la operación

Devuelve

{ result }

Respuesta cruda del API de Tilopay bajo la llave `result`.

Última verificación: 2026-09-14 · Responsable: equipo-integraciones

Ver como Markdown crudo