O que é um callback? 


Ao utilizar uma de nossas APIs, você pode realizar chamadas para consultar dados, criar registros ou executar ações específicas. Algumas dessas ações envolvem processamentos assíncronos, ou seja, a resposta da API não é imediata, pois o servidor pode depender de processos externos ou verificações adicionais.

Para esses casos, você pode configurar um callback, que nada mais é do que informar ao servidor uma URL para que ele envie a resposta automaticamente assim que o processo for concluído.


▶️ Exemplo prático 


Imagine que você está utilizando a API para gerar um QR Code de pagamento. O fluxo funcionaria assim:

  1. Você faz a requisição → recebe uma resposta síncrona com o QR Code, status CREATED, e os dados (copia e cola, base64 da imagem, etc.).

  2. Quando o pagamento é realizado, o sistema envia uma requisição assíncrona (callback) para sua URL cadastrada, atualizando o status para APPROVED.


Como cadastrar uma URL de callback? 


Para configurar sua URL de callback:

  1. Abra um chamado no nosso portal de suporte.

  2. Informe a URL desejada e o ambiente (homologação ou produção).

  3. Recomenda-se uma URL específica para cada ambiente, evitando confusão nos dados.

  4. A alteração de URL em ambiente de produção pode levar até 5 dias úteis.


Observação específica para QR Code: 


  • Você pode informar uma URL de callback personalizada diretamente na requisição usando o parâmetro callbackAddress.

  • Quando esse parâmetro é usado, o callback será enviado para a URL da requisição, e não para a URL padrão cadastrada anteriormente.


⚠️ Observações Importantes

  • Os callbacks são enviados via uma fila de processamento.

  • Para confirmar o recebimento, seu sistema deve responder com status HTTP 200 (OK).

  • Retornos diferentes de 200 (como 400 ou 500) ativam o fluxo de retentativas.

  • Alto volume de erros pode resultar na desativação temporária dos callbacks até que o problema seja corrigido.


Documentação técnica completa 


Em anexo, você encontra a documentação detalhada da API de callback, com exemplos práticos e todas as informações necessárias para a implementação correta. 


Suporte


Para dúvidas ou acompanhamento de chamados, acesse: Portal de Suporte