Sempre que existe uma alteração de status em um pagamento do parceiro que possui integração ativa, a plataforma da SX faz uma chamada JSON do tipo POST para o endpoint definido do painel do parceiro, vide abaixo como funciona a ativação da integração dentro do painel do parceiro:
A imagem abaixo mostra o painel do parceiro com a integração desativada
Ao definir uma URL para as chamadas e clicar em "Salvar" a integração será ativada e a Chave gerada
Sempre que há uma alteração de status em um pagamento criado através da API a plataforma da SX faz uma chamada do tipo POST para a URL definida conforme imagem acima com a seguinte estrutura:
Body
{
"timestamp": 1619746055968,
"id": "608b5054b09661258f21debf",
}
Descrição dos campos:
timestamp - Timestamp do momento exato da chamada.
id - ID do link de pagamento gerado pela SX no momento da criação do link.
Com esta chamada Webhook seu sistema pode realizar uma chamada para o nosso endpoint de consulta de Status para verificar o status atual, outros dados do pagamento e atualizá-lo internamente.
Seu sistema precisa responder qualquer coisa com o status http da família 200, caso contrário a plataforma da SX fará a chamada novamente a cada 10 minutos até que uma resposta de sucesso (status http 200) seja retornada.