> ## Documentation Index
> Fetch the complete documentation index at: https://support.wepayments.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Automação de Fluxos de Trabalho

Este guia aborda a automação de operações de pagamento via API, incluindo criação de chaves de API, whitelist de IPs, controle de acesso, permissões e notificações via webhook.

## Visão geral da automação

As APIs da WEpayments permitem automatizar operações de pagamento, reduzindo o trabalho manual no Dashboard e possibilitando integração fluida com seus sistemas internos.

### O que pode ser automatizado

| **Operação**                                      | **Método de automação** |
| :------------------------------------------------ | :---------------------- |
| **Payin (criação de cobrança)**                   | API                     |
| **Payout (criação de pagamento)**                 | API                     |
| **Data Collect (auto-cadastro de beneficiários)** | API                     |
| **Validação de chave PIX**                        | API                     |
| **Verificação de status de transações**           | API ou webhooks         |
| **Download de extratos**                          | API                     |
| **Envio de documentos KYC**                       | API                     |

## Configuração de autenticação da API

Para automatizar operações via API, você precisa de:

| **Requisito**                    | **Descrição**                                                |
| :------------------------------- | :----------------------------------------------------------- |
| **Usuário de API**               | Usuário dedicado criado no Dashboard (não para login humano) |
| **Chave de API**                 | Gerada por usuário – exibida apenas uma vez                  |
| **Whitelist de IP**              | Endereços IP autorizados a utilizar a chave                  |
| **Autenticação de dois fatores** | Obrigatória para gerar e excluir chaves de API               |

### Passo a passo

| **Etapa**                  | **Ação**                                                                                    |
| :------------------------- | :------------------------------------------------------------------------------------------ |
| **1. Criar usuário**       | Configurações > Controle de Acesso > Criar Usuário (somente Moderador)                      |
| **2. Atribuir permissões** | Selecione as funcionalidades que a API pode executar (cobranças, pagamentos, extratos, KYC) |
| **3. Gerar chave de API**  | Na tela de edição do usuário > seção Chave de API > Criar Chave de API                      |
| **4. Informar IPs**        | É necessário pelo menos um endereço IP                                                      |
| **5. Fornecer código 2FA** | Obrigatório por segurança                                                                   |
| **6. Copiar e armazenar**  | A chave é exibida apenas uma vez – armazene com segurança                                   |

> 💡 Somente IPs listados no whitelist podem realizar chamadas usando a chave de API.

## Controle de acesso e permissões

O menu de **Controle de Acesso** é visível apenas para usuários com permissão de **Moderador**.

| **Perfil**       | **O que permite**                                                                  |
| :--------------- | :--------------------------------------------------------------------------------- |
| **Moderador**    | Acesso completo – pode criar novos usuários, editar acessos e gerenciar permissões |
| **Escrita**      | Pode criar pagamentos e cobranças, editar informações                              |
| **Visualização** | Somente leitura – não pode criar nem editar                                        |

> 💡 As permissões disponíveis dependem do tipo de produto adquirido.

### Permissões do usuário de API

Ao criar um usuário de API, você pode atribuir permissões específicas, como:

| **Permissão**                 | **O que a API pode fazer**                          |
| :---------------------------- | :-------------------------------------------------- |
| **Criar cobranças (payin)**   | Criar cobranças via PIX, boleto e cartão de crédito |
| **Criar pagamentos (payout)** | Enviar pagamentos para beneficiários                |
| **Visualizar extrato**        | Consultar saldo e extratos de transações            |
| **Inserir documentos KYC**    | Enviar documentos de compliance                     |

## Notificações via webhook

Webhooks são callbacks HTTP que enviam dados de eventos em tempo real para o seu endpoint quando eventos específicos ocorrem.

### Eventos comuns de webhook

| **Evento**               | **Quando é acionado**              |
| :----------------------- | :--------------------------------- |
| **Pagamento confirmado** | Payout concluído com sucesso       |
| **Cobrança recebida**    | Pagamento Payin confirmado         |
| **Documento solicitado** | Documentos KYC/KYL necessários     |
| **Documento aprovado**   | Documentos de compliance aprovados |
| **Transação em análise** | Revisão de compliance acionada     |

> 💡 Configuração de webhook: Entre em contato com o suporte para obter detalhes sobre configuração de endpoint e assinatura de eventos.

## Melhores práticas de automação

| **Prática**                               | **Por quê**                                               |
| :---------------------------------------- | :-------------------------------------------------------- |
| **Usar usuário de API dedicado**          | Evita perda de acesso caso um colaborador saia da empresa |
| **Minimizar permissões**                  | Conceda apenas o que a API precisa                        |
| **Armazenar chaves de API com segurança** | As chaves são exibidas apenas uma vez                     |
| **Implementar lógica de retry**           | Trate falhas transitórias de forma adequada               |
| **Monitorar uso da API**                  | Detecte padrões incomuns                                  |
| **Testar no sandbox primeiro**            | Valide antes de ir para produção                          |

## Configuração de notificações

No menu de **Notificações**, você pode configurar como deseja receber notificações sobre operações de pagamento, cobrança ou compliance.

| **Configuração**  | **Opções**                                                                   |
| :---------------- | :--------------------------------------------------------------------------- |
| **Canal**         | E-mail, Dashboard, webhook                                                   |
| **Eventos**       | Confirmação de pagamento, cobrança recebida, solicitação de documentos, etc. |
| **Destinatários** | Endereços de e-mail ou usuários do Dashboard                                 |

> ⚠️ **Observação:** Algumas opções de notificação ainda não estão totalmente disponíveis. Entre em contato com o suporte para verificar o status atual.