Webhooks

Enviamos Webhooks para a URL informada no campo 'webhookUrl' em determinados casos de uso. Através desses Webhooks, sua aplicação receberá dados das transações em tempo real, permitindo tratativas e validações conforme sua lógica de negócio.

Nossas requisições são sempre enviadas via POST. Certifique-se de que seu ambiente esteja preparado para receber chamadas nesse formato.

Headers [Cabeçalhos] Nossas requisições para sua aplicação incluirão os seguintes cabeçalhos.

Nome

Accept: application/json *

Tipo

string

Descrição

Esperamos respostas em formato JSON.
Nome

Content-Type: application/json *

Tipo

string

Descrição

Enviaremos requisições em formato JSON.
Nome

signature *

Tipo

string

Descrição

Enviaremos um hash de verificação para garantir a integridade dos dados. Você pode usar esse hash para validar se a requisição é realmente nossa.

POST Depósito Pago

{
    "type": "PIX",
    "event": "deposit",
    "payer": "JHON WALKER",
    "status": "paid",
    "paid_at": "30-04-2025 07:41:50",
    "reference": "eedb304f-595e-1e51-b1ca-9f57919a1e32",
    "endToEndId": "E0036030521350930103280dc1d7e36f",
    "value_cents": 300
}

POST Transferência Paga

{
    "type": "PIX",
    "event": "transfer",
    "destination": "JHON WALKER",
    "status": "paid",
    "paid_at": "30-04-2025 07:41:50",
    "reference": "eedb304f-595e-1e51-b1ca-9f57919a1e32",
    "endToEndId": "E0036030521350930103280dc1d7e36f",
    "value_cents": 300
}