Sopague Documentação

Quando um pagamento é processado (Gateway 2D, Gateway 3D ou Link de Pagamento), a plataforma envia automaticamente uma notificação HTTP POST para a URL de callback configurada no campo urlCallBack da requisição de pagamento.

Configuração

Inclua o parâmetro urlCallBack na requisição de pagamento:

{
  "urlCallBack": "https://seusite.com.br/webhook/pagamento"
}

Corpo da Notificação

Gateway 2D/3D

{
  "Value": 100.50,
  "Origin": "GATEWAY_2D",
  "Date": "2025-09-11T14:30:25Z",
  "Installments": 1,
  "TransactionType": "CREDIT",
  "ResultId": "010078826509090055210005100989250000000000",
  "AuthorizationCode": "2345",
  "Status": "0",
  "PaymentLinkId": null
}

Link de Pagamento

{
  "Value": 50.00,
  "Origin": "PAYMENT_LINK_2D",
  "Date": "2025-09-11T14:30:25Z",
  "Installments": 1,
  "TransactionType": "CREDIT",
  "ResultId": "010078826509090055210005100989250000000000",
  "AuthorizationCode": "2345",
  "Status": "0",
  "PaymentLinkId": "3c228652-122e-4da6-b572-4aea64caad63"
}

Campos do Payload

Headers HTTP

As requisições do webhook são enviadas com o header Access-Key, que garante a autenticidade da requisição. Solicite ao suporte a sua Access-Key para configurar na sua aplicação.

Content-Type: application/json
Access-Key: callback-id-123

Requisitos do Endpoint de Destino

Aceitar requisições POST
Retornar status HTTP 200 para notificações recebidas com sucesso

Para interpretar corretamente os status das transações recebidas via webhook, consulte a tabela de Códigos de Resposta.