Referencia de la API
Explora el esquema OpenAPI, la referencia interactiva Scalar y el catálogo completo de endpoints del tenant.
Contrato en vivo
El portal publica un contrato OpenAPI descargable en /openapi.json y un explorador interactivo Scalar en /api-reference (también en el host de la API en /reference). Cada esquema de request/response se genera desde los decoradores de NestJS — usa Scalar cuando necesites tipos, ejemplos y pruebas en vivo por campo.
Todos los endpoints del tenant
Matriz completa método × path de la API de tenant. Abre /api-reference y selecciona una operación para ver los esquemas completos de request/response.
| Método | Path | Tag | Propósito |
|---|---|---|---|
| GET | /v1/banks | Banks | Catálogo de bancos (code, name, services, logoUrl) |
| GET | /v1/quote?usdAmount= | Payments | Cotización BCV (liquidación + mediana) |
| POST | /v1/payments/c2p/request | Payments | Crear intent C2P + solicitar OTP bancario |
| POST | /v1/payments/c2p | Payments | Ejecutar cobro C2P con token del cliente |
| POST | /v1/payments/vpos | Payments | Cobro VPOS con tarjeta (BNC, solo PCI) |
| POST | /v1/payments/pago-movil/verify | Payments | Verificar referencia Pago Móvil (BNC o R4) |
| GET | /v1/payments/by-ref/:externalRef | Payments | Último pago por referencia de correlación |
| GET | /v1/payments/:id | Payments | Recibo de pago por id |
| POST | /v1/payments/:id/reverse | Payments | Reversar un C2P completado |
| POST | /v1/payments/debit/otp | Advanced payments | Solicitar OTP de débito inmediato (VES) |
| POST | /v1/payments/debit | Advanced payments | Ejecutar débito inmediato |
| GET | /v1/payments/operations/:id | Advanced payments | Consultar operación de red pendiente |
| POST | /v1/payments/credit | Advanced payments | Crédito inmediato por teléfono |
| POST | /v1/payments/credit/account | Advanced payments | Crédito a cuenta de 20 dígitos |
| POST | /v1/payments/credit/disburse | Advanced payments | Dispersar Pago Móvil entrante por teléfono |
| POST | /v1/payments/payouts | Advanced payments | Dispersión multi-beneficiario a cuentas |
| POST | /v1/payments/change | Advanced payments | Enviar vuelto al cliente |
| POST | /v1/merchants | Merchants | Registrar comerciante (+ método opcional) |
| GET | /v1/merchants | Merchants | Listar o buscar por externalRef |
| GET | /v1/merchants/:id | Merchants | Detalle + métodos de payout |
| PATCH | /v1/merchants/:id | Merchants | Activar / desactivar comerciante |
| DELETE | /v1/merchants/:id | Merchants | Eliminar si no hay historial de payouts |
| GET | /v1/merchants/:id/payout-methods | Merchants | Listar métodos Pago Móvil |
| POST | /v1/merchants/:id/payout-methods | Merchants | Agregar método de payout |
| POST | /v1/merchants/:id/payout-methods/:methodId/default | Merchants | Definir método por defecto |
| DELETE | /v1/merchants/:id/payout-methods/:methodId | Merchants | Eliminar método de payout |
| POST | /v1/merchants/:id/payout-methods/:methodId/verify/start | Merchants | Iniciar microdepósitos |
| POST | /v1/merchants/:id/payout-methods/:methodId/verify | Merchants | Confirmar montos de microdepósito |
| POST | /v1/merchants/:id/verify/start | Merchants | Legado: verificar método default |
| POST | /v1/merchants/:id/verify | Merchants | Legado: confirmar método default |
| POST | /v1/payouts | Payouts | Crear payout simple (idempotente) |
| POST | /v1/payouts/batch | Payouts | Batch con resultados por ítem |
| GET | /v1/payouts | Payouts | Listar payouts (paginación por cursor) |
| GET | /v1/payouts/by-ref/:externalRef | Payouts | Payout por externalRef |
| GET | /v1/payouts/:id | Payouts | Payout por id |
| POST | /v1/webhooks | Webhooks | Registrar endpoint (secret una sola vez) |
| GET | /v1/webhooks | Webhooks | Listar endpoints (sin secrets) |
| PATCH | /v1/webhooks/:id | Webhooks | Actualizar url / events / active |
| DELETE | /v1/webhooks/:id | Webhooks | Eliminar endpoint + historial |
| POST | /v1/notifications/test | Webhooks | Enviar notification.test a suscriptores |
Markdown para IA / LLM
Si conectas un agente de código o un pipeline RAG, usa estas superficies Markdown en lugar de scrapear el HTML. Siguen la convención llms.txt.
| URL | Propósito |
|---|---|
| /llms.txt | Índice curado con enlaces a páginas Markdown |
| /llms-full.txt | Guía completa en inglés en un solo Markdown |
| /{slug}.md | Una guía como Markdown limpio (p. ej. /merchants-payouts.md) |
| /index.html.md | Markdown de la descripción general |
| /es/llms.txt | Índice en español |
| /es/llms-full.txt | Guía completa en español en un solo Markdown |
| /es/{slug}.md | Markdown de una página en español |
| /openapi.json | Contrato OpenAPI 3 machine-readable (alimenta Scalar) |
| /api-reference | UI interactiva Scalar de cada operación documentada |
Contrato desplegado
Abre el explorador de la API
El explorador interactivo y el esquema legible por máquinas se sirven directamente desde este portal.
GET /openapi.json