---
title: Asaas
slug: asaas
docTags: 
createdAt: 2024-10-29T17:59:14.798Z
---

## Objetivo

O conector Asaas permite integrar a plataforma Fluid com a API do [Asaas](https://asaas.com/) para automatizar operações financeiras, como criação e gerenciamento de cobranças, clientes, assinaturas, parcelamentos, entre outros.

## Criando um fluxo

Para utilizar o conector Asaas em um fluxo no Fluid:

1. Acesse a aba **Fluxos**.
2. Clique em **Criar Fluxo** e selecione o conector **Asaas**.
3. Escolha um recurso e uma operação (detalhados abaixo).

## Criando conexão

A conexão com o Asaas exige os seguintes campos:

| Campo    | Tipo   | Descrição                                         |
| -------- | ------ | ------------------------------------------------- |
| Ambiente | Enum   | Ambiente de autenticação: `sandbox` ou `producao` |
| Token    | String | Token de autenticação da API                      |

## Configurando fluxo

Após selecionar a operação desejada, o Fluid irá solicitar os dados obrigatórios para execução. Os campos variam conforme o recurso escolhido, e incluem parâmetros de path e corpo da requisição.

## Recursos e Operações

### Cobranças

- **Criar nova cobrança**
  - Campos obrigatórios: `customer`, `billingType`, `value`, `dueDate`
  - Campos opcionais: `description`, `discount`, `fine`, `interest`, `externalReference`, `split`, `installmentCount`, `installmentValue`, `totalValue`, `callback`, entre outros.
- **Atualizar cobrança existente**
  - Campos obrigatórios: `id`, `corpo`
  - Campos opcionais: mesmos da criação
- **Excluir cobrança**
  - Campo obrigatório: `id`
- **Recuperar uma única cobrança**
  - Campo obrigatório: `id`
- **Listar cobranças**
  - Filtros opcionais: `customer`, `status`, `dueDate`, `paymentDate`, `externalReference`, entre outros
- **Pagar uma cobrança com cartão de crédito**
  - Campos obrigatórios: `id`, `creditCard`, `creditCardHolderInfo` ou `creditCardToken`
- **Confirmar recebimento em dinheiro**
  - Campos obrigatórios: `id`, `paymentDate`, `value`
- **Obter QR Code para pagamentos via Pix**
  - Campo obrigatório: `id`
- **Recuperar status de uma cobrança**
  - Campo obrigatório: `id`
- **Estornar cobrança**
  - Campos obrigatórios: `id`, `value`, `description`
- **Capturar cobrança com pré-autorização**
  - Campo obrigatório: `id`
- **Restaurar cobrança removida**
  - Campo obrigatório: `id`
- **Obter linha digitável do boleto**
  - Campo obrigatório: `id`
- **Recuperar informações de pagamento de uma cobrança**
  - Campo obrigatório: `id`
- **Informações sobre visualização da cobrança**
  - Campo obrigatório: `id`

### Clientes

- **Criar novo cliente**
  - Campos obrigatórios: `name`, `cpfCnpj`
  - Campos opcionais: `email`, `phone`, `mobilePhone`, `address`, `postalCode`, entre outros
- **Atualizar cliente existente**
  - Campos obrigatórios: `id`, `corpo`
- **Remover cliente**
  - Campo obrigatório: `id`
- **Restaurar cliente removido**
  - Campo obrigatório: `id`
- **Listar clientes**
  - Filtros opcionais: `name`, `cpfCnpj`, `email`, `externalReference`
- **Recuperar um único cliente**
  - Campo obrigatório: `id`

### Parcelamentos

- **Criar parcelamento**
  - Campos obrigatórios: `installmentCount`, `customer`, `value`, `billingType`, `dueDate`
- **Criar parcelamento com cartão de crédito**
  - Campos obrigatórios: `installmentCount`, `customer`, `value`, `billingType`, `dueDate`, `creditCard`, `creditCardHolderInfo`, `remoteIp`
- **Estornar parcelamento**
  - Campos obrigatórios: `id`
- **Remover parcelamento**
  - Campo obrigatório: `id`
- **Listar parcelamentos**
  - Filtros opcionais: `limit`, `offset`

### Assinaturas

- **Listar cobranças de uma assinatura**
  - Campo obrigatório: `id`
- **Gerar carnê de assinatura**
  - Campo obrigatório: `id`
- **Atualiza o cartão de crédito sem efetuar cobrança**
  - Campos obrigatórios: `id`, `creditCard`, `creditCardHolderInfo`, `remoteIp`

### Cartão de crédito

- **Tokenização de cartão de crédito**
  - Campos obrigatórios: `customer`, `creditCard`, `creditCardHolderInfo`, `remoteIp`

### Estornos

- **Listar estornos de uma cobrança**
  - Campo obrigatório: `id`
- **Estornar boleto**
  - Campos obrigatórios: `id`, `corpo`

### Conta Escrow

- **Encerrar garantia da cobrança**
  - Campos obrigatórios: `id`, `corpo`

## Na prática

Exemplo de fluxo para criação de uma nova cobrança:

- Recurso: Cobranças
- Operação: Criar nova cobrança
- Campos:
  - `customer`: cus\_123456
  - `value`: 150.00
  - `dueDate`: 2025-08-01
  - `billingType`: BOLETO

## Disparando o Fluxo

O fluxo pode ser disparado por evento, agendamento, API externa ou manualmente na interface do Fluid.

## Conclusão

Este conector oferece integração completa com a API Asaas, permitindo automação de cobranças, clientes, parcelamentos, notificações e muito mais.