Webhooks permitem que sua aplicação receba notificações em tempo real sobre eventos importantes da CartãoSimples.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.
Atenção — Webhook disponível
Atualmente, o único webhook disponível é o de atualização de status do Pedido.
Segmentação de webhooks
Ambientes e Webhooks
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
Configurar webhooks
Fale com o atendimento
Para configurar os seus webhooks, entre em contato com o nosso atendimento pelo e-mail atendimento@CartãoSimples.com.br
Tipos de Autenticação
Aceitamos três tipos de autenticação para os webhooks:Sem Autenticação (Não recomendado)
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.
Basic
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.
Bearer JWT
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.
Payload do Webhook
O payload enviado para o endpoint do webhook é um JSON com a seguinte estrutura:Legenda do EnumStatus
0 - Undefined
Status indefinido.
1 - Analysing
O pedido está sendo analisado automaticamente.
2 - Approved
O pedido foi aprovado.
3 - UnavailableBalance
Saldo indisponível para a operação.
4 - AnalysisExpired
O prazo de análise do pedido expirou.
5 - PendingPayment
Aguardando o pagamento.
6 - BiometryRefused
Biometria recusada.
7 - BiometryApproved
Biometria aprovada.
8 - PaymentRefused
Pagamento recusado.
9 - Purchased
Compra realizada com sucesso.
10 - NotAuthorized
Operação não autorizada.
11 - PendingAuthorization
Aguardando autorização.
12 - WaitingRegistration
Aguardando o cadastro do cliente.
13 - SaleNotStarted
A venda ainda não foi iniciada.
14 - Canceled
O pedido foi cancelado.
15 - Billing
Em processo de cobrança.
16 - Done
Processo concluído com sucesso.
17 - Frozen
Pedido congelado por inadimplência.
18 - PendingPaymentConfirmation
Aguardando confirmação do pagamento.