Webhooks (PIX)

Para garantir a sincronização em tempo real entre a nossa plataforma e o seu sistema, é obrigatório o uso de Webhooks. Através deles, você receberá notificações automáticas sempre que houver uma alteração no status de uma transação.

Requisitos Técnicos

Protocolo: REST Webhook

Método HTTP: POST

Formato do Corpo: JSON

Segurança: Recomendamos a validação do campo hash enviado no payload para garantir a integridade dos dados.

PIX Cash-in (Entrada)

Este webhook é disparado quando um pagamento via PIX é identificado ou devolvido.

Campos do Payload

Cabeçalho da tabela	Tipo	Descrição
idTransaction	String	ID único da transação.
typeTransaction	String	Tipo da transação (Fixo: PIX).
statusTransaction	String	Status: PAID_OUT (Confirmado) ou CHARGEBACK (Devolvido).
value	Number	Valor da transação.
payerName	String	Nome do pagador.
payerTaxId	String	CPF/CNPJ do pagador.
paymentDate	String	Data e hora (dd/MM/yyyy HH:mm:ss).
paymentCode	String	Código brCode (Copia e Cola).
requestNumber	String	Seu número de controle enviado na requisição original.

Exemplo de JSON (Cash-in)

PIX Cash-out (Saída)

Este webhook é disparado para informar o sucesso ou a falha de uma transferência enviada por você.

Campos do Payload

Cabeçalho da tabela	Tipo	Descrição
idTransaction	String	ID único da transação.
typeTransaction	String	Tipo da transação (Fixo: PIX_CASHOUT).
statusTransaction	String	Status: PAID_OUT (Sucesso) ou CANCELED (Cancelado/Falha).
value	Number	Valor da transação.
destinationName	String	Nome do beneficiário.
destinationTaxId	String	CPF/CNPJ do beneficiário.
requestNumber	String	Seu número de controle enviado na requisição original.

Exemplo de JSON (Cash-out)

💡 Dica de Implementação: Certifique-se de que seu servidor responda com um status 200 OK rapidamente ao receber o POST para evitar tentativas de reenvio desnecessárias.

Webhooks de Transação

Webhooks (PIX)#

Requisitos Técnicos#

PIX Cash-in (Entrada)#

Campos do Payload#

Exemplo de JSON (Cash-in)#

PIX Cash-out (Saída)#

Campos do Payload#

Exemplo de JSON (Cash-out)#

💡 Dica de Implementação: Certifique-se de que seu servidor responda com um status 200 OK rapidamente ao receber o POST para evitar tentativas de reenvio desnecessárias.#

Webhooks (PIX)

Requisitos Técnicos

PIX Cash-in (Entrada)

Campos do Payload

Exemplo de JSON (Cash-in)

PIX Cash-out (Saída)

Campos do Payload

Exemplo de JSON (Cash-out)

💡 Dica de Implementação: Certifique-se de que seu servidor responda com um status 200 OK rapidamente ao receber o POST para evitar tentativas de reenvio desnecessárias.