SopagueDocs
v3

Reenviar Webhook

POST/api/webhook/resend

Enfileira o reenvio assíncrono de um webhook de pagamento para a URL de callback previamente cadastrada na transação original.


Autenticação e Segurança

  • Tipo: Bearer Token JWT ([Authorize("Bearer")])

Cabeçalhos (Headers)

CabeçalhoValorObrigatórioDescrição
AuthorizationBearer <token>SimToken JWT de autenticação
Content-Typeapplication/jsonSimTipo de conteúdo enviado

Parâmetros

Exemplo de requisição
{
  "paymentResultId": "PAY_9876543210"
}

Retorno (202)

Exemplo de resposta
{
  "paymentLinkId": "105432",
  "paymentResultId": "105432",
  "status": "queued"
}

Dicionário de dados

Erros

[
  {
    "tag": "PaymentResultId",
    "description": "O ID do resultado do pagamento é obrigatório."
  }
]

Cenários de Erro

Status HTTPTagDescriçãoMotivo / Regra de Negócio
400 Bad RequestPaymentResultIdO ID do resultado do pagamento é obrigatório.Campo ausente ou vazio na requisição.
400 Bad RequestPaymentResultIdO ID do resultado do pagamento deve ter no máximo 50 caracteres.Identificador excede o limite máximo de 50 caracteres.
400 Bad Request""Webhook não encontrado.Registro não encontrado em PaymentGatewayHistory ou pertence a outra conta (ContaNroConta).
401 Unauthorized""Não autorizado.Bearer Token ausente, inválido ou expirado.
409 ConflicturlCallBackO webhook não possui URL de callback.O registro original da transação não possui urlCallBack configurada.
409 Conflict""O webhook já foi processado com sucesso.A notificação já retornou HTTP 200 OK anteriormente (evita duplicidade).

Certifique-se de que o seu endpoint de destino esteja preparado para receber requisições POST e responda com status HTTP 200 OK assim que processar o evento.