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-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
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 (number): Valor da transaçãoexternalId (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-sucedida
name (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
Boas Práticas
O Webhook deve retornar Status Code 200
Para que a transação tenha seu fluxo finalizado com Sucesso é de extrema importancia que seja retornado 200 na resposta!
