Referencia de API

Documentación técnica completa

Documentación completa de todos los endpoints de la API de TAPI. Explora nuestros servicios organizados por categorías y encuentra toda la información técnica que necesitas para integrar con nuestra plataforma.

35+

Endpoints disponibles

Categorías de servicios

REST

API estándar

Autenticación

Endpoints para gestionar la autenticación y autorización de usuarios.

POST

Autenticación de usuarios para obtener tokens de acceso a la API

/login

Servicios

Gestión de empresas, consulta de deudas y procesamiento de pagos de servicios.

Companies

GET

Obtener lista completa de empresas disponibles para servicios

/services

Company Code

GET

Obtener información detallada de una empresa específica

/{companyCode}

Debts

POST

Consultar deudas pendientes de un cliente específico

/debts

Process Payment

POST

Procesar el pago de una deuda específica

/payment

Confirm Payment

WEBHOOK

Confirmar la finalización exitosa de un pago

/confirm-payment

Status

GET

Verificar el estado actual de una transacción

/operation/{operationId}

Agenda

Gestión de adhesiones y notificaciones de servicios.

Get Adhesions

GET

Obtener adhesiones de servicios del cliente

/adhesions/{externalClientId}

Post Adhesions

POST

Crear nuevas adhesiones de servicios

/adhesions/register

Update Adhesions

PATCH

Actualizar adhesiones existentes

/adhesions

Notifications

GET

Obtener notificaciones de la agenda

/notifications/{externalClientId}

Autopay

Débito automático sobre adhesiones de agenda: suscripción, consulta, notificación y confirmación de débitos.

Ciclo de vida

GUÍA

Visión general del flujo de débito automático de extremo a extremo

/autopay

Suscribir a Autopay

PATCH

Activar o desactivar el débito automático sobre una adhesión existente

/automatic-debit

Notificación de débito

WEBHOOK

Webhook que tapi envía por cada factura nueva de una adhesión suscripta

debit-incoming

Confirmar débito

POST

Informar a tapi que el débito sobre la cuenta del usuario fue ejecutado

/automatic-debit/confirm

Recargas

Servicios de recarga de saldo para operadores móviles y otros servicios.

Recharge Companies

GET

Obtener empresas disponibles para recargas

/recharges

Recharge Products

GET

Obtener productos de recarga de una empresa específica

/{companyCode}

Process Recharge

POST

Procesar una recarga de saldo

/payment

Confirm Recharge

WEBHOOK

Confirmar la finalización de una recarga

/confirmPayment

Recharge Status

GET

Verificar el estado de una recarga

/operation/{operationId}

Suscripciones

Gestión de suscripciones y gift cards para diferentes servicios.

Subscription Companies

GET

Obtener empresas disponibles para suscripciones

/subscriptions

Subscription Products

GET

Obtener productos de suscripción de una empresa específica

/subscriptions/{companyCode}

Subscription Payment

POST

Procesar el pago de una suscripción

/payment

Herramientas

Utilidades para consultar saldo, tipos de cambio y otras herramientas auxiliares.

Balance

GET

Consultar el saldo disponible en la cuenta

/wallet/balance

Exchange

GET

Obtener tipos de cambio actuales

/exchange/rate

CICO Emisores

Cash In / Cash Out para emisores: generación de referencias, autorización de operaciones, notificaciones, consulta de operaciones y red de puntos de pago.

Descripción Funcional

GUÍA

Visión general del flujo de Cash In / Cash Out para emisores

descripcion

Seguridad

GUÍA

Requisitos de firma, autenticación y protección de las operaciones

seguridad

Generación de Referencias

POST

Generar la referencia de pago para una operación

/references