​

Documentação do Webhook de Cash-in

​

Visão Geral

Nosso sistema de webhook envia notificações em tempo real sobre transações de cash-in. Quando o status de uma transação é alterado, uma requisição POST é enviada para a URL configurada com informações detalhadas da transação.

​

Payload do Webhook

O webhook envia um payload JSON contendo os detalhes e status da transação.

​

Exemplo de Payload

{
  "transactionId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "transactionStatus": "PAID", 
  "transactionType": "CASH_IN",
  "value": "100.00",
  "externalId": "pedido_123456",
  "e2e_id": "Exxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "debtorAccount": {
    "name": "João da Silva",
    "document": "123.***.***-00",
    "accountType": "TRAN"
  }
}

​

Descrição dos Campos

​

Informações da Transação

• transactionId (string): Identificador único da transação no formato UUID
• transactionStatus (string): Status atual da transação. Valores possíveis:
  • PAID: Transação concluída com sucesso
• transactionType (string): Tipo da transação, neste caso “CASH_IN”
• value (string): Valor da transação
• externalId (string): ID de referência externa fornecido pelo cliente
• e2e_id (string): Identificador fim-a-fim da transação

​

Informações da Conta do Pagador

• debtorAccount (objeto): Informações sobre a conta que está enviando o dinheiro
  • name (string): Nome completo do titular da conta
  • document (string): Número do documento (CPF) parcialmente mascarado
  • accountType (string): Tipo de conta, ex: “TRAN” para conta transacional

​

Boas Práticas

​

O Webhook deve retornar Status Code 200