Callbacks

Para otimizar a performance, nossos endpoints utilizam callbacks assíncronos. Ao receber a requisição, a API:

• Persiste imediatamente os dados no banco

• Enfileira o processamento “pesado” em background

• Assim que a tarefa é concluída, dispara uma callback/webhook para o seu sistema com as informações finais.

ConfiguraçãoCopied!

Para certos endpoints, é necessário informar o parâmetro url_callback no corpo da requisição. Assim que o processamento assíncrono for concluído, a API faz um POST para essa URL passando o payload com o status e os dados finais do recurso.

• Parâmetro

  • url_callback (string, obrigatório em endpoints específicos): endpoint HTTP para receber a notificação com o resultado.

• Fluxo

  • Cliente envia a requisição incluindo url_callback.

  • API persiste os dados e enfileira o processamento em background.

  • Ao término, API dispara uma chamada POST para a URL informada com o JSON de retorno.

Exemplo de callbackCopied!

{
  "success": true,
  "type": "registered",
  "accounts_receivable_id": "c6ceb54f-c1da-41f4-934e-a1a730b6d159",
  "payment_data": {
    "typeable_line": "21390001171200003300600018740902510930000005900",
    "barcode": "21395109300000059000001112000033000001874090",
    "our_number": "00001874090",
    "pix_copy_and_paste": "00020101021226910014BR.GOV.BCB.PIX2569qrcode-h.bancoarbi.com.br/gi/v2/cobv/b56960f71c484df4affaebbbe2b6a54a5204000053039865802BR5907K8 Bank6008Curitiba61088102067062070503***63043D50",
    "qrcode_image": "https://sandbox.meuk8.com.br/pix?data=00020101021226910014BR.GOV.BCB.PIX2569qrcode-h.bancoarbi.com.br/gi/v2/cobv/b56960f71c484df4affaebbbe2b6a54a5204000053039865802BR5907K8 Bank6008Curitiba61088102067062070503***63043D50",
    "pdf": "http://painel.localhost/account-receivable/download/1/c6ceb1748289134"
  }
}

Retornos padrao nas callbacks

• “success”: true | false

• “type”: “error” | “cancelled” | ”registered” | “paid“ | “sent”