Skip to content

Webhooks (Recebimento)

O sistema está preparado para receber notificações automáticas (push) de diversos gateways e bancos parceiros. Estes endpoints são consumidos diretamente pelas instituições quando ocorrem eventos como liquidação de boletos, recebimento de Pix ou falha em transações de cartão.


[POST] /webhook/payment

Recebe notificações genéricas de processamento de pagamentos para links de checkout.

Request Body (Exemplo)

json
{
  "reference_id": "PAY-abc12345",
  "status": "paid",
  "transaction_id": "gw_987654",
  "amount": 150.00,
  "currency": "BRL"
}

Response (200 OK)

json
{
  "message": "Webhook processado"
}

Response (404 Not Found)

json
{
  "message": "Pagamento não encontrado"
}

Notificações Sicredi

[POST] /webhook/sicredi

[POST] /webhook/sicredi/pix

[POST] /webhook/sicredi/out

[POST] /webhook/sicredi/boleto

Endpoints específicos para a infraestrutura do Sicredi (Pix dinâmico, Pix de saída e Boletos).

Request Body Pix In (Exemplo Sicredi)

json
{
  "pix": [
    {
      "endToEndId": "E0000000020241225103000000001",
      "txid": "ch_7a8b9c",
      "valor": "150.00",
      "horario": "2024-12-25T10:30:00Z",
      "infoPagador": "Pagamento mensalidade"
    }
  ]
}

Response (200 OK)

json
{
  "status": "success"
}

Notificações Sicoob

[POST] /webhook/sicoob/pix-in/{type?}

[POST] /webhook/sicoob/boleto

[POST] /webhook/sicoob/pix-out

Response (200 OK)

json
{ "message": "OK" }

Outros Gateways

[POST] /webhook/stripe

Notificações de eventos do Stripe (Checkout Session, Payment Intent).

[POST] /webhook/justa

Retorno de transações via Gateway Justa.

[POST] /webhook/ioniq

Retorno de transações via Gateway Ioniq.

[POST] /webhook/pagmaxx

Retorno de transações via Gateway Pagmaxx.


Ambiente Sandbox

[ANY] /webhook/sandbox

Endpoint utilizado para testes manuais de integração e inspeção de payloads recebidos. Ideal para debugar novas integrações sem afetar o ambiente de produção.

Response (200 OK)

json
{
  "success": true,
  "received_at": "2024-12-26T16:15:00Z",
  "payload": { "... dados recebidos ..." }
}

(Nota: O payload é retornado conforme enviado para fins de depuração)

Webhooks de Saída (Saída do Sistema para o Cliente)

Quando você cria uma cobrança ou link de pagamento, pode informar uma webhook_url. O sistema enviará os seguintes payloads para a sua URL conforme o evento:

Evento: Cobrança Paga

json
{
  "event": "charge.paid",
  "data": {
    "code": "ch_xyz123",
    "amount_paid": 250.0,
    "paid_at": "2024-12-26T16:15:00Z",
    "payment_method": "PIX",
    "client": {
      "name": "João Silva",
      "document": "12345678901"
    }
  }
}

(As respostas às suas notificações devem retornar status HTTP 200)

Documentação para Desenvolvedores