Documentação do Webhook de Cash-out
Visão Geral
Nosso sistema de webhook envia notificações em tempo real sobre transações de cash-out. 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
Descrição dos Campos
Informações da Transação
transactionId(string): Identificador único da transação no formato UUIDtransactionStatus(string): Status atual da transação. Valores possíveis:PAID: Transação concluída com sucessoFAILED: Transação falhouCHARGEBACK: Transação estornada
transactionType(string): Tipo da transação, sempre “CASH_OUT”value(string): Valor da transação (decimal em formato string, ex:"100.00")externalId(string): ID de referência externa fornecido pelo clienteerror_message(string, opcional): Mensagem de erro quando a transação falha ou é estornadacreditorAccount(objeto, opcional): Informações da conta do beneficiário quando a transação é bem-sucedidaname(string): Nome do beneficiáriodocument(string): Documento do beneficiárioaccountType(string): Tipo da conta
e2e_id(string, opcional): Identificador único da transação PIX
Exemplos por Status
Transação Bem-sucedida
Transação Falha
Transação Estornada
Segurança: Verificação de Assinatura
Toda requisição deste webhook é assinada com HMAC-SHA256 (headerX-Webhook-Signature), usando o seu api_secret como chave. Valide a assinatura
antes de processar o payload para garantir que a notificação veio realmente da
3X Pay e não foi adulterada no caminho.
Guia completo: Segurança dos Webhooks
Headers de segurança, fórmula da assinatura e exemplos de validação (Node.js, Python, PHP).