Webhook

O Webhook é uma forma passiva de receber, via HTTP POST, as notificações de mudança de status dos pagamentos, sem precisar consultar ativamente. O contrato enviado é o mesmo dos endpoints de consulta (tributos, boletos e Pix).

⚠️
⚠️ Somente Produção, não há Sandbox.
Os endpoints de manutenção do webhook existem apenas em produção, na base https://mtls-api-parceiro.sicredi.com.br/multipag-cadastro.

Requisito: uma URL da sua aplicação, disponível na internet, para receber as notificações.

Consultar cadastro

GET /v1/associado/webhook, escopos: multipag.pix.pagar, multipag.boleto.pagar, multipag.tributos.pagar. Headers: Authorization, x-conta, x-cooperativa, x-documento.

Response (sucesso):

{
  "urlCallback": "http://api-callback",
  "authorizationCallback": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIi..."
}

Atualizar cadastro

PATCH /v1/associado/webhook, mesmos escopos e headers. Body: urlCallback e authorizationCallback.

{
  "urlCallback": "http://api-callback",
  "authorizationCallback": "SEU_TOKEN_CALLBACK"
}

📘
Nota
Ambos os campos são obrigatórios no body. Para limpar (deixar nulo) um dos valores, envie string vazia ("").

Authorization callback, segurança

Você pode configurar um token de acesso: o authorizationCallback é enviado pelo Sicredi no header Authorization de cada chamada feita à sua URL. Valide esse header no seu endpoint para garantir que a mensagem é legítima e veio do Sicredi.