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

# Webhooks

> Receba notificações sobre atualizações

Webhooks permitem que sua aplicação receba notificações em tempo real sobre eventos importantes da CartãoSimples.

<Card title="Atenção — Webhook disponível" icon="triangle-exclamation" horizontal color="#ef4444">
  Atualmente, **o único webhook disponível** é o de **atualização de status do Pedido**.
</Card>

## <Icon icon="mobile" type="solid" /> Segmentação de webhooks

<Card title="Ambientes e Webhooks" icon="book" horizontal>
  Os webhooks são específicos para cada ambiente:

  * Webhooks criados em **desenvolvimento** recebem notificações apenas do ambiente de desenvolvimento
  * Webhooks criados em **produção** recebem notificações apenas de dados reais

  Saiba mais sobre o ambiente de desenvolvimento <a href="./development">aqui</a>.
</Card>

## <Icon icon="key" type="solid" /> Configurar webhooks

<Card title="Fale com o atendimento" icon="headset" horizontal color="#25c2a0">
  Para configurar os seus webhooks, entre em contato com o nosso atendimento pelo e-mail <Icon icon="envelope" type="solid" /> atendimento\@CartãoSimples.com.br
</Card>

## <Icon icon="shield-halved" type="solid" /> Tipos de Autenticação

Aceitamos três tipos de autenticação para os webhooks:

<Card title="Sem Autenticação (Não recomendado)" icon="triangle-exclamation" horizontal color="#ef4444">
  Se o seu endpoint não requer autenticação, você pode optar por não usar nenhum método de autenticação. Nesse caso, as notificações serão enviadas para o seu endpoint sem nenhum cabeçalho de autenticação.
</Card>

<Card title="Basic" icon="user-lock" color="#25c2a0" horizontal>
  A autenticação Basic é um método de autenticação HTTP simples que envolve o envio de um nome de usuário e senha com cada requisição. Para usar a autenticação Basic, você precisará fornecer um nome de usuário e uma senha ao configurar o webhook.
</Card>

<Card title="Bearer JWT" icon="id-card" color="#25c2a0" horizontal>
  A autenticação Bearer JWT é um método de autenticação que usa um token JSON Web Token (JWT) para autenticar as requisições. Para usar a autenticação Bearer JWT, você precisará fornecer um token JWT válido ao configurar o webhook.
</Card>

## <Icon icon="code" type="solid" /> Payload do Webhook

O payload enviado para o endpoint do webhook é um JSON com a seguinte estrutura:

```json theme={null}
{
  "id_pedido": "00000000-0000-0000-0000-000000000000",
  "enum_status": 1,
  "status": "Analysing",
}
```

### Legenda do EnumStatus

<CardGroup>
  <Card title="0 - Undefined" icon="circle-question" color="#9e9e9e" horizontal>
    Status indefinido.
  </Card>

  <Card title="1 - Analysing" icon="magnifying-glass-chart" color="#ff9800" horizontal>
    O pedido está sendo analisado automaticamente.
  </Card>

  <Card title="2 - Approved" icon="check" color="#4caf50" horizontal>
    O pedido foi aprovado.
  </Card>

  <Card title="3 - UnavailableBalance" icon="wallet" color="#f44336" horizontal>
    Saldo indisponível para a operação.
  </Card>

  <Card title="4 - AnalysisExpired" icon="clock" color="#795548" horizontal>
    O prazo de análise do pedido expirou.
  </Card>

  <Card title="5 - PendingPayment" icon="hourglass-half" color="#ff9800" horizontal>
    Aguardando o pagamento.
  </Card>

  <Card title="6 - BiometryRefused" icon="fingerprint" color="#f44336" horizontal>
    Biometria recusada.
  </Card>

  <Card title="7 - BiometryApproved" icon="fingerprint" color="#4caf50" horizontal>
    Biometria aprovada.
  </Card>

  <Card title="8 - PaymentRefused" icon="credit-card" color="#f44336" horizontal>
    Pagamento recusado.
  </Card>

  <Card title="9 - Purchased" icon="bag-shopping" color="#2196f3" horizontal>
    Compra realizada com sucesso.
  </Card>

  <Card title="10 - NotAuthorized" icon="ban" color="#f44336" horizontal>
    Operação não autorizada.
  </Card>

  <Card title="11 - PendingAuthorization" icon="lock" color="#ff9800" horizontal>
    Aguardando autorização.
  </Card>

  <Card title="12 - WaitingRegistration" icon="user-clock" color="#ff9800" horizontal>
    Aguardando o cadastro do cliente.
  </Card>

  <Card title="13 - SaleNotStarted" icon="circle-pause" color="#9e9e9e" horizontal>
    A venda ainda não foi iniciada.
  </Card>

  <Card title="14 - Canceled" icon="ban" color="#9e9e9e" horizontal>
    O pedido foi cancelado.
  </Card>

  <Card title="15 - Billing" icon="file-invoice" color="#2196f3" horizontal>
    Em processo de cobrança.
  </Card>

  <Card title="16 - Done" icon="check-double" color="#4caf50" horizontal>
    Processo concluído com sucesso.
  </Card>

  <Card title="17 - Frozen" icon="snowflake" color="#607d8b" horizontal>
    Pedido congelado por inadimplência.
  </Card>

  <Card title="18 - PendingPaymentConfirmation" icon="circle-check" color="#ff9800" horizontal>
    Aguardando confirmação do pagamento.
  </Card>
</CardGroup>
