# OnePay Documentación ## Docs - [Lectura de llaves Bre-B](https://docs.onepay.la/client/accounts/bre-b-keys.md): Endpoint para obtener las llaves de Bre-B. - [Crear Cuenta](https://docs.onepay.la/client/accounts/create.md): Endpoint para crear una cuenta bancaria. - [Crear Cuenta Bre-B](https://docs.onepay.la/client/accounts/create-breb.md): Crea cuentas con llave Bre-B para enviar dinero. - [Eliminar Cuenta](https://docs.onepay.la/client/accounts/delete.md): Elimine una cuenta bancaria objetivo. - [Ver Cuenta](https://docs.onepay.la/client/accounts/detail.md): Obtiene los detalles de una cuenta bancaria específica. - [Introducción](https://docs.onepay.la/client/accounts/index.md): Gestiona las cuentas bancarias inscritas de tus clientes. - [Listado de cuentas](https://docs.onepay.la/client/accounts/list.md): Endpoint para obtener el listado de cuentas bancarias. - [Listado de bancos](https://docs.onepay.la/client/accounts/list-banks.md): Endpoint para obtener el listado de bancos soportados por OnePay. - [Actualizar cuenta](https://docs.onepay.la/client/accounts/update.md): Actualiza una cuenta bancaria objetivo. - [Validar cuenta](https://docs.onepay.la/client/accounts/validate.md): Valida una cuenta bancaria para habilitar débitos automáticos. - [Solicitar dispersión](https://docs.onepay.la/client/balance/cashout.md): Solicita la dispersión del balance a una cuenta bancaria registrada de tu empresa. - [Obtener balance](https://docs.onepay.la/client/balance/get.md): Endpoint para obtener el balance de la cuenta de OnePay. - [Autenticación](https://docs.onepay.la/client/base/autentication.md): Autenticación de peticiones en el API - [Entornos en OnePay](https://docs.onepay.la/client/base/environments.md) - [Códigos de error](https://docs.onepay.la/client/base/errors/codes.md): Códigos de error estándar para el manejo de errores via API. - [Manejo de errores](https://docs.onepay.la/client/base/errors/index.md): Estandar para el manejo de errores via API. - [Llamadas de cobro](https://docs.onepay.la/client/calls/index.md) - [Enviar campaña de sensibilización masiva](https://docs.onepay.la/client/campaigns/import-messages.md): Envía una campaña de sensibilización masiva por WhatsApp a una lista de números telefónicos. - [Crear tarjetas](https://docs.onepay.la/client/cards/create.md): Endpoint para registrar una tarjeta de crédito o débito en el sistema de OnePay. - [Crear tarjetas tokenizadas](https://docs.onepay.la/client/cards/create-tokenized.md): Endpoint para registrar una tarjeta que ha sido previamente tokenizada por el SDK. - [Eliminar tarjeta](https://docs.onepay.la/client/cards/delete.md): Endpoint para eliminar una tarjeta de crédito o débito en el sistema de OnePay. - [Detalle tarjeta](https://docs.onepay.la/client/cards/detail.md): Endpoint para obtener los detalles de una tarjeta de crédito o débito registrada en OnePay. - [Introducción](https://docs.onepay.la/client/cards/index.md): Gestiona las tarjetas de tus clientes. - [Listar tarjetas](https://docs.onepay.la/client/cards/list.md): Endpoint para obtener las tarjetas de crédito o débito registradas en el sistema de OnePay. - [Crear dispersión](https://docs.onepay.la/client/cashouts/create.md): Endpoint para registrar una dispersión en el sistema de OnePay. - [Cancelar dispersión](https://docs.onepay.la/client/cashouts/delete.md): Endpoint para cancelar una dispersión en el sistema de OnePay. - [Detalle dispersión](https://docs.onepay.la/client/cashouts/detail.md): Endpoint para obtener los detalles de una dispersión en el sistema de OnePay. - [Introducción](https://docs.onepay.la/client/cashouts/index.md): Envía dinero a cuentas bancarias y billeteras digitales de tus clientes. - [Listar dispersiones](https://docs.onepay.la/client/cashouts/list.md): Obtén las dispersiones registradas en tu compañía con filtros y paginación. - [Crear un QR (Bre-B)](https://docs.onepay.la/client/charges/bre-b.md): Endpoint para crear un código QR para pagos con Bre-B. - [Cancelar cargo](https://docs.onepay.la/client/charges/cancel.md): Endpoint para cancelar un cargo en el sistema de OnePay. - [Crear cargo](https://docs.onepay.la/client/charges/create.md): Endpoint para crear un cargo en el sistema de OnePay. - [Detalle cargo](https://docs.onepay.la/client/charges/detail.md): Endpoint para obtener los detalles de un cargo en el sistema de OnePay. - [Introducción](https://docs.onepay.la/client/charges/index.md): Gestiona los débitos y cargos autorizados de tus clientes. - [Crear un link de pago (PSE)](https://docs.onepay.la/client/charges/link.md): Endpoint para registrar un cargo en el sistema de OnePay. - [Listar cargos](https://docs.onepay.la/client/charges/list.md): Endpoint para obtener los cargos registrados en el sistema de OnePay. - [Reembolsar cargo](https://docs.onepay.la/client/charges/refund.md): Endpoint para reembolsar un cargo en el sistema de OnePay. - [Resolver cargo (Testing)](https://docs.onepay.la/client/charges/resolve.md): Aprueba o rechaza manualmente un cargo de prueba en estado processing o created. - [Escenarios de prueba](https://docs.onepay.la/client/charges/scenarios.md): Simula diferentes resultados de transacciones en ambiente de pruebas. - [Crear empresa](https://docs.onepay.la/client/companies/create.md): Crea una nueva empresa asociada a tu cuenta. Los usuarios con permiso switch_company serán vinculados automáticamente como miembros. - [Crear link de captura](https://docs.onepay.la/client/connections/create.md): Crea un nuevo link de captura, para que el cliente pueda registrar su información de pago. - [Eliminar link de captura](https://docs.onepay.la/client/connections/delete.md): Elimina un link de captura específico de tu cuenta. - [Links de Captura](https://docs.onepay.la/client/connections/index.md): Captura información de pago de tus clientes de forma segura - [Crear cargo](https://docs.onepay.la/client/customer-session/create-charge.md): Crea un cargo a una tarjeta del cliente autenticado. Requiere aprobación del cliente vía WhatsApp. - [Tokenizar tarjeta](https://docs.onepay.la/client/customer-session/create-payment-method.md): Registra una nueva tarjeta de crédito/débito para el cliente autenticado usando tokenización. - [Sesión de cliente](https://docs.onepay.la/client/customer-session/index.md): Permite a tus clientes autenticarse con OTP y operar con sus métodos de pago de forma segura. - [Listar métodos de pago](https://docs.onepay.la/client/customer-session/list-payment-methods.md): Retorna los métodos de pago del cliente autenticado: tarjetas, billeteras y cuentas PSE. - [Solicitar OTP](https://docs.onepay.la/client/customer-session/request-otp.md): Envía un código OTP de 6 dígitos al cliente vía WhatsApp para iniciar sesión. - [Consultar cargo](https://docs.onepay.la/client/customer-session/show-charge.md): Consulta el estado y detalle de un cargo creado en la sesión del cliente. - [Verificar OTP](https://docs.onepay.la/client/customer-session/verify-otp.md): Verifica el código OTP y retorna un token de sesión para el cliente. - [Cuentas de un cliente](https://docs.onepay.la/client/customers/accounts.md) - [Tarjetas de un cliente](https://docs.onepay.la/client/customers/cards.md) - [Crear clientes](https://docs.onepay.la/client/customers/create.md): Crea un nuevo cliente en tu cuenta. - [Eliminar cliente](https://docs.onepay.la/client/customers/delete.md) - [Detalles de un cliente](https://docs.onepay.la/client/customers/detail.md) - [Introducción](https://docs.onepay.la/client/customers/index.md): Gestiona los clientes de tus transacciones. - [Tarjetas emitidas a un cliente](https://docs.onepay.la/client/customers/issuing-cards.md) - [Listado de clientes](https://docs.onepay.la/client/customers/list.md) - [[Flujo] Pago de facturas](https://docs.onepay.la/client/flows/bill-payment.md): Invoca un flujo para ante una acción del usuario. - [Invocar flujos](https://docs.onepay.la/client/flows/create.md): Invoca un flujo para ante una acción del usuario. - [Eliminar facturas masivamente](https://docs.onepay.la/client/invoices/bulk-delete.md): Elimina de forma masiva todas las facturas pendientes de la empresa autenticada. - [Crear factura](https://docs.onepay.la/client/invoices/create.md): Crea una nueva factura y su Payment asociado. - [Eliminar factura](https://docs.onepay.la/client/invoices/delete.md): Cancela el Payment asociado y elimina la factura. - [Obtener factura](https://docs.onepay.la/client/invoices/get.md): Devuelve el detalle de una factura, incluyendo el Payment asociado. - [Introducción](https://docs.onepay.la/client/invoices/index.md): Guía técnica para integrar facturas con OnePay — flujo de integración, estados, webhooks y funcionalidades avanzadas. - [Listar facturas](https://docs.onepay.la/client/invoices/list.md): Obtiene un listado paginado de facturas de tu cuenta. - [Actualizar factura](https://docs.onepay.la/client/invoices/update.md): Actualiza una factura existente. Cancela el Payment anterior, crea uno nuevo y lo asocia a la factura. - [Crear tarjetas](https://docs.onepay.la/client/issuing/cards/create.md): Crea una nueva tarjeta en tu cuenta. - [Eliminar tarjetas](https://docs.onepay.la/client/issuing/cards/delete.md): La tarjeta sera marcada como cancelada. - [Detalles de tarjeta](https://docs.onepay.la/client/issuing/cards/detail.md): Obtenga el detalle de la tarjeta. - [Habilitar tarjeta](https://docs.onepay.la/client/issuing/cards/enable-card.md): [Solo tarjetas físicas] - [Congelar tarjeta](https://docs.onepay.la/client/issuing/cards/froze.md): Congela una tarjeta existente. - [Listar tarjetas](https://docs.onepay.la/client/issuing/cards/list.md): Obtén una lista de todas las tarjetas creadas en tu cuenta. - [Transacciones de tarjetas](https://docs.onepay.la/client/issuing/cards/transactions.md): Obtiene las transacciones de una tarjeta. - [Descongelar tarjeta](https://docs.onepay.la/client/issuing/cards/unfroze.md): Descongela una tarjeta existente. - [Actualizar tarjetas](https://docs.onepay.la/client/issuing/cards/update.md): Actualiza una tarjeta existente. - [Actualizar pin](https://docs.onepay.la/client/issuing/cards/update-pin.md): [Solo tarjetas fisicas] Actualiza el pin de la tarjeta - [Ver datos de tarjeta](https://docs.onepay.la/client/issuing/cards/view.md): Obtiene el iframe de la tarjeta para que puedas mostrarlo en tu sitio web. - [Introducción](https://docs.onepay.la/client/issuing/index.md): Gestiona las tarjetas de tus clientes. - [Obtener payment intent](https://docs.onepay.la/client/payment-intent/get.md): Obtiene el detalle de un payment intent (intento de pago) de tu compañía - [Listar payment intents](https://docs.onepay.la/client/payment-intent/list.md): Obtiene una lista paginada de payment intents (intentos de pago) de tu compañía - [Crear cobro](https://docs.onepay.la/client/payments/create.md) - [Eliminar cobro](https://docs.onepay.la/client/payments/delete.md): Este endpoint te permite eliminar un cobro existente - [Ver cobro](https://docs.onepay.la/client/payments/detail.md): Este endpoint te permite obtener el detalle de un cobro. - [Introducción](https://docs.onepay.la/client/payments/index.md): Gestiona los cobros y solicitudes de pago de tus clientes. - [Intentos de pago](https://docs.onepay.la/client/payments/intents.md): Endpoint para obtener la lista de intentos asociados a un pago en el sistema de OnePay. - [Listar cobros](https://docs.onepay.la/client/payments/list.md): Este endpoint te permite obtener una lista de todos los cobros - [Reenviar cobro](https://docs.onepay.la/client/payments/resend.md): Reenvia una solicitud de pago a tu cliente. - [Crear clientes](https://docs.onepay.la/client/plans/create.md): Crea un nuevo cliente en tu cuenta. - [Eliminar plan](https://docs.onepay.la/client/plans/delete.md): Elimina un plan específico de tu cuenta. - [Introducción](https://docs.onepay.la/client/plans/index.md): Gestiona los planes de cobro recurrente para tus clientes. - [Listado de planes](https://docs.onepay.la/client/plans/list.md): Obtiene el listado de planes disponibles. - [Daviplata](https://docs.onepay.la/client/request-to-pay/daviplata.md): Crea un Request to Pay para Daviplata. - [Daviplata Confirm](https://docs.onepay.la/client/request-to-pay/daviplata-confirm.md): Confirma un Request to Pay para Daviplata. - [Introducción](https://docs.onepay.la/client/request-to-pay/index.md): Genera solicitudes de cobro directas a Nequi y DaviPlata. - [Nequi](https://docs.onepay.la/client/request-to-pay/nequi.md): Crea un Request to Pay para Nequi. - [Nequi Confirm](https://docs.onepay.la/client/request-to-pay/nequi-confirm.md): Confirma un Request to Pay para Nequi. - [Crear suscripción](https://docs.onepay.la/client/subscriptions/create.md): Crea una suscripción recurrente asociada a un cliente. - [Eliminar suscripción](https://docs.onepay.la/client/subscriptions/delete.md): Elimina una suscripción específica de tu cuenta. - [Introducción](https://docs.onepay.la/client/subscriptions/index.md): Gestiona las suscripciones de tus clientes. - [Listado de suscripciones](https://docs.onepay.la/client/subscriptions/list.md): Obtiene las suscripciones creadas en tu cuenta con filtros y paginación. - [Casos de uso de débitos automáticos](https://docs.onepay.la/client/use-cases/charges.md): Debita tarjetas, cuentas bancarias o billeteras digitales. Cada método tiene su propio flujo de captura y tiempos de procesamiento. - [Cobro de facturas desde tu sistema de gestión](https://docs.onepay.la/client/use-cases/invoices.md): Conecta tu sistema de facturación con OnePay y automatiza el cobro. Tú generas la factura, OnePay se encarga de cobrarla. - [Casos de uso de cobros](https://docs.onepay.la/client/use-cases/payments.md): Un solo endpoint, múltiples canales. Aprende qué campos enviar según cómo quieras cobrar. - [Dispersión](https://docs.onepay.la/client/use-cases/payouts.md): Dispersa dinero a múltiples destinatarios de forma rápida y segura. - [Tokenizar cuentas Nequi y Daviplata](https://docs.onepay.la/client/use-cases/tokenizar-cuentas.md): Vincula cuentas de Nequi y Daviplata para habilitar débitos automáticos. - [Eliminar debito por id](https://docs.onepay.la/client/utilities/auto-debit-delete.md): Elimina un debito automatico suscrito de tus clientes. - [Eliminar debito por referencia](https://docs.onepay.la/client/utilities/auto-debit-delete-ref.md): Elimina un debito automatico suscrito de tus clientes. - [Generar link de domiciliación](https://docs.onepay.la/client/utilities/auto-debit-link.md): Genera un link firmado para que un cliente suscriba su método de pago al débito automático de facturas. - [Listado de débitos suscritos a facturas](https://docs.onepay.la/client/utilities/auto-debit-list.md): Obtenga el listado de débitos automáticos suscritos de tus clientes. - [Listado de cobros suscritos a débitos de facturas](https://docs.onepay.la/client/utilities/direct-debit-payments.md): Obtenga el listado de débitos automáticos suscritos de tus clientes. - [Realizar pago](https://docs.onepay.la/client/utilities/payment.md): Realiza un pago a un convenio. - [Consultar convenios](https://docs.onepay.la/client/utilities/providers.md): Obtenga los detalles de un convenio por referencia. - [Consultar convenio por referencia](https://docs.onepay.la/client/utilities/query.md): Obtenga los detalles de un convenio por referencia. - [Generar link de pago](https://docs.onepay.la/client/utilities/session-link.md): Genera un link de pago para un convenio. - [Ver pago](https://docs.onepay.la/client/utilities/view.md): Obtenga los detalles de un pago específico. - [Balance](https://docs.onepay.la/client/wallets/balance.md): Obtener balance de una billetera. - [Cuentas relacionadas](https://docs.onepay.la/client/wallets/delete-related-account.md): Obtener cuentas relacionadas de un cliente - [Cuentas relacionadas](https://docs.onepay.la/client/wallets/related-accounts.md): Obtener cuentas relacionadas de un cliente - [Extracto mensual](https://docs.onepay.la/client/wallets/statement.md): Solicita el extracto mensual de movimientos de la wallet de un cliente. Se envía por correo electrónico. - [Cargar billetera](https://docs.onepay.la/client/wallets/toupwallet.md): Cargar billetera con balance de tu compañia. - [Detalle de una transaccion](https://docs.onepay.la/client/wallets/transaction.md): Obtener detalle de una transacción. - [Transacciones](https://docs.onepay.la/client/wallets/transactions.md): Obtener transacciones de una billetera. - [Billetera a billetera](https://docs.onepay.la/client/wallets/transfer.md): Enviar dinero a otra billetera. - [Conciliación Asobancaria](https://docs.onepay.la/client/webhooks/asobancaria.md): Descarga y procesa archivos de conciliación en formato Asobancaria para reconciliar pagos. - [Crear webhook](https://docs.onepay.la/client/webhooks/create.md): Registra una nueva URL para recibir notificaciones de eventos de tu cuenta. - [Eliminar webhook](https://docs.onepay.la/client/webhooks/delete.md): Elimina un webhook de tu cuenta. Esta acción es irreversible. - [Ver webhook](https://docs.onepay.la/client/webhooks/detail.md): Retorna el detalle de un webhook específico. - [Ejemplos de payloads](https://docs.onepay.la/client/webhooks/ejemplos.md): Estructura de los payloads que recibirás en tu URL al dispararse cada evento de webhook. - [Webhooks](https://docs.onepay.la/client/webhooks/index.md): Recibe notificaciones en tiempo real cuando ocurren eventos en tu cuenta de OnePay. - [Listar webhooks](https://docs.onepay.la/client/webhooks/list.md): Retorna todos los webhooks registrados en tu cuenta, ordenados por fecha de creación descendente. - [Actualizar webhook](https://docs.onepay.la/client/webhooks/update.md): Modifica el nombre, URL o eventos de un webhook existente. Todos los campos son opcionales. - [Crear link de pago](https://docs.onepay.la/docs/cobros/create-payment-link.md): Aprende a crear un link de pago en menos de 30 segundos. - [Importar archivos y realizar cobros masivos en OnePay](https://docs.onepay.la/docs/cobros/import-file.md): Aprende a importar archivos y realizar cobros masivos en OnePay. - [Cobrar](https://docs.onepay.la/docs/cobros/index.md) - [Marca blanca](https://docs.onepay.la/docs/config/brand.md): Personalia la identidad de tus links de pago. - [Compañía](https://docs.onepay.la/docs/config/company-info.md): Configura la información de tu empresa para redirigir a tus clientes a tus canales. - [Link personalizable](https://docs.onepay.la/docs/config/custom-link.md): Permite a tus clientes la libertad de pagar el valor que escojan - [Métodos de pago](https://docs.onepay.la/docs/config/payment-method.md): Configuración de métodos de pago disponibles por default - [Portal web](https://docs.onepay.la/docs/config/portal.md): Permite a tus clientes consultar su saldo pendiente y pagar en segundos. - [Subdomain](https://docs.onepay.la/docs/config/subdomain.md): Empieza a utilizar OnePay en minutos - [Gestion de contracargos](https://docs.onepay.la/docs/dispute/introduction.md): Guía de Motivos de Contracargo - [Contracargo perdido](https://docs.onepay.la/docs/dispute/lost.md): Qué sucede cuando pierdes un contracargo, comisiones aplicadas y cómo prevenir futuros casos. - [Contracargo ganado](https://docs.onepay.la/docs/dispute/won.md): Qué sucede cuando ganas un contracargo y cómo aprovechar el resultado. - [Elementos de captura de datos sensibles](https://docs.onepay.la/docs/elements/index.md): Los elementos de captura de datos sensibles son componentes que permiten capturar datos sensibles como números de tarjetas, CVVs y fechas de vencimiento de manera segura y personalizada. - [Integración del SDK Elements](https://docs.onepay.la/docs/elements/introduction.md): Captura datos de tarjetas de forma segura cumpliendo PCI DSS con el SDK Elements de OnePay. - [Integraciones](https://docs.onepay.la/docs/integraciones/index.md): Automatiza tus cobros con nuestras integraciones. - [Integración con Siigo](https://docs.onepay.la/docs/integraciones/siigo.md): Guía paso a paso para integrar OnePay con Siigo, incluyendo configuración, administración y solución de problemas comunes. - [Resumen](https://docs.onepay.la/docs/introduction/overview.md): Crea una cuenta y aprende como empezar a usar OnePay. - [Empezar ahora](https://docs.onepay.la/docs/introduction/quick-start.md): Crea tu cuenta en segundos y prueba OnePay sin complicaciones - [Transferir](https://docs.onepay.la/docs/transfers/index.md) - [Autenticación](https://docs.onepay.la/docs/verification/authentication.md): Verificación de identidad del representante legal. - [Documentos digitales](https://docs.onepay.la/docs/verification/documents.md): Carga los documentos solicitados para el debido análisis de la compańía. - [Información legal](https://docs.onepay.la/docs/verification/legal-info.md): Ingresa la información de la compańía y representante legal para su revisión. - [Empezar proceso](https://docs.onepay.la/docs/verification/overview.md): Completar el proceso para verificar tu cuenta tomará 5 minutos. - [Revisión](https://docs.onepay.la/docs/verification/review.md): La revisión puede tomar hasta un día hábil. - [Cobrar con débito directo](https://docs.onepay.la/guides/cobrar-debito.md): Debita automáticamente tarjetas de crédito/débito o cuentas bancarias autorizadas. - [Cobrar con link de pago](https://docs.onepay.la/guides/cobrar-link-pago.md): Envía un cobro por WhatsApp, email, portal de pagos o comparte un link directo. - [Conceptos clave](https://docs.onepay.la/guides/conceptos-clave.md): Entiende los conceptos fundamentales de OnePay antes de integrar. - [Dispersar dinero (Payouts)](https://docs.onepay.la/guides/dispersar-dinero.md): Envía dinero a cuentas bancarias de terceros con diferentes velocidades de transferencia. - [Implementar webhooks](https://docs.onepay.la/guides/implementar-webhooks.md): Recibe notificaciones en tiempo real sobre pagos, cargos, dispersiones y otros eventos. - [Bienvenidos a OnePay](https://docs.onepay.la/introduction.md): Bienvenidos a la documentación de OnePay, aquí podrás encontrar toda la información necesaria para interactuar con nuestra plataforma - [Bre-B](https://docs.onepay.la/updates/bre-b.md): Bre-B - [Dispersiones](https://docs.onepay.la/updates/cashouts.md): Ultimos cambios y novedades sobre el proceso de dispersiones - [Cobros](https://docs.onepay.la/updates/collections.md): Cobros - [Actualizaciones](https://docs.onepay.la/updates/index.md): Últimas actualizaciones de OnePay ## OpenAPI Specs - [package](https://docs.onepay.la/package.json) - [package-lock](https://docs.onepay.la/package-lock.json) - [.eslintrc](https://docs.onepay.la/.eslintrc.json) - [openapi](https://docs.onepay.la/api-reference/openapi.json)