Webhooks

Quando o status de uma transação muda, a EvoPay faz um POST para a callbackUrl fornecida na criação.

Headers enviados

Content-Type: application/json

Payload — Depósito (DEPOSIT)

{
  "id": "cmq47c6un0c05ufvvo58ohpqk",
  "type": "DEPOSIT",
  "status": "COMPLETED",
  "amount": 100.00,
  "endToEndId": "E60746948202406101500abcdef123456",
  "payerDocument": "12345678901",
  "payerName": "João Silva"
}

Campo	Tipo	Descrição
`id`	`string`	ID da transação
`type`	`"DEPOSIT"`	Tipo fixo
`status`	`TransactionStatus`	Status atual
`amount`	`number`	Valor em reais
`endToEndId`	`string \| null`	ID fim a fim Pix — presente após liquidação
`payerDocument`	`string \| null`	CPF/CNPJ do pagador — presente após pagamento
`payerName`	`string \| null`	Nome do pagador — presente após pagamento

Payload — Saque (WITHDRAW)

{
  "id": "cmq47c6un0c05ufvvo58ohpqk",
  "type": "WITHDRAW",
  "status": "COMPLETED",
  "amount": 100.00,
  "endToEndId": "E60746948202406101500abcdef123456"
}

Campo	Tipo	Descrição
`id`	`string`	ID da transação
`type`	`"WITHDRAW"`	Tipo fixo
`status`	`TransactionStatus`	Status atual
`amount`	`number`	Valor em reais
`endToEndId`	`string \| null`	ID fim a fim Pix — presente após liquidação

Política de entrega

O callback é uma única tentativa — não há reenvio automático em caso de falha. Sua aplicação deve ser resiliente: retorne 2xx rapidamente e processe o evento de forma assíncrona.

Idempotência

O mesmo evento pode ser entregue mais de uma vez (ex: reprocessamento interno). Trate idempotência usando a combinação id + status.

Consultando o status

Se o callback não for recebido, consulte o status diretamente:

curl "https://pix.evopay.cash/v1/pix?id=cmq47c6un0c05ufvvo58ohpqk" \
  -H "API-Key: SEU_TOKEN"