Tools de Asaas
Las 12 operaciones de Asaas que tu producto ejecuta en la cuenta de tu cliente con Connect. Todas usan el mismo endpoint, POST /api/tools/{tool}/execute.
- Listar clientesGETLista los clientes (pagadores) de la cuenta, con filtro opcional por nombre, email, CPF o CNPJ, grupo o referencia externa. La respuesta trae data, totalCount y hasMore; pagina con offset y limit mientras hasMore sea true.
- Consultar clienteGETDevuelve un cliente, con nombre, CPF o CNPJ, email, teléfonos, dirección y configuración de notificación.
- Crear clientePOSTCrea un cliente, el pagador de cobros y suscripciones. name y cpfCnpj son obligatorios. No hay campo de ciudad: Asaas toma la ciudad del postalCode.
- Actualizar clientePUTActualiza un cliente. Los campos no enviados se mantienen como están.
- Listar cobrosGETLista los cobros (cobrancas), con filtro opcional por cliente, suscripción, estado, forma de pago, fecha de pago o referencia externa. Los valores están en reales. La respuesta trae data, totalCount y hasMore; pagina con offset y limit mientras hasMore sea true.
- Consultar cobroGETDevuelve un cobro, con estado, valor, valor neto, vencimiento, fecha de pago y los enlaces invoiceUrl (la página del cobro) y bankSlipUrl (el boleto).
- Crear cobroPOSTCrea un cobro para un cliente, por boleto, Pix o tarjeta de crédito, en un pago o en cuotas. La respuesta trae invoiceUrl, la página del cobro para enviar al pagador, y Asaas puede notificar al cliente según su configuración de notificación.
- Actualizar cobroPUTActualiza un cobro aún pendiente o vencido; el cliente no se puede cambiar. Envía billingType, value y dueDate aunque no cambien, con los valores actuales de Get payment. Un nuevo valor o vencimiento puede notificar al cliente.
- Eliminar cobroDELETEElimina un cobro, que ya no se puede pagar; se puede restaurar en Asaas. No reembolsa un valor ya pagado, y eliminar un cobro de una suscripción no termina la suscripción.
- Listar suscripcionesGETLista las suscripciones, con filtro opcional por cliente, estado, forma de pago o referencia externa. Los cobros que genera una suscripción vienen de List payments con el filtro de suscripción. Pagina con offset y limit mientras hasMore sea true.
- Crear suscripciónPOSTCrea una suscripción para un cliente, que genera un cobro por ciclo, el primero con vencimiento en nextDueDate. Los cobros aparecen en List payments con el filtro de suscripción.
- Actualizar suscripciónPUTActualiza una suscripción. Los cambios valen para los cobros aún no generados, salvo que updatePendingPayments sea true. status INACTIVE suspende la suscripción y conserva sus cobros, y ACTIVE la reactiva con un nuevo nextDueDate.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.

Conta Azul