Callback: Retorno de Status de Operação (`atualizaStatus`)

🔁 Endpoint implementado pelo CLIENTE. O Qprof chama este método no seu sistema para devolver o status das operações (borderô e títulos) que foram importados via API.

A API de integração Qprof disponibiliza serviços para retorno de status de operações realizadas pelos Títulos que foram importados utilizando a API. Para a utilização é necessario disponibilizar uma API para o envio de retornos obedecendo o padrão de comunicação a seguir:

Padrão de comunicação

Autenticação em 2 etapas (mesmo padrão da Qprof API). Seu sistema deve expor obrigatoriamente os métodos authentication (autenticação) e atualizaStatus (recebimento do status do retorno da operação).

O corpo trafega como arquivo gzip (JSON comprimido), pela possibilidade de grande volume de dados.

Requisição recebida (Qprof → Cliente)

{
  "cnpj_empresa": "00.000.000/0000-00",
  "cpf_cnpj_cedente": "000.000.000-00 ou 00.000.000/0000-00",
  "bordero": 1,
  "status_bordero": "P",
  "numero_remessa_qcertifica": 1,
  "valor_total_bruto": 0.00,
  "valor_desagio": 0.00,
  "valor_ad_valorem": 0.00,
  "valor_tarifas": 0.00,
  "valor_impostos_dvrs": 0.00,
  "valor_recibos": 0.00,
  "valor_descontos": 0.00,
  "valor_total_liquido": 0.00,
  "titulos": [
    {
      "cpf_cnpj_sacado": "00.000.000-00 ou 00.000.000/0000-00",
      "numero_titulo": "12456333",
      "status": "A",
      "valor_aquisicao": 0.00,
      "valor_desagio": 0.00,
      "valor_tarifa": 0.00
    }
  ]
}

Estrutura

Propriedade	Tipo	Descrição
`cnpj_empresa`	String	CNPJ da empresa parametrizada para envio de títulos.
`cpf_cnpj_cedente`	String	CNPJ do cedente que realizou o envio dos títulos.
`bordero`	Number	Número do borderô gerado no Q'Prof a partir dos títulos enviados.
`status_bordero`	String	Status do borderô (ver tabela abaixo).
`titulos`	Array	Lista de objetos Título.

Valores de `status_bordero`

Valor	Significado
`P`	Pago
`L`	Liberado
`E`	Excluído / Cancelado
`C`	Enviado para assinatura
`A`	Totalmente assinado

Objeto Título

Propriedade	Tipo	Descrição
`cpf_cnpj_sacado`	String	CNPJ do sacado vinculado ao título.
`numero_titulo`	Number	Número do título que foi enviado.
`status`	String	Status do título: `A` - Aceito, `R` - Rejeitado.

Resposta esperada (Cliente → Qprof)

Retorne apenas o HTTP Status Code 200 (sucesso) ou 400 (falha), com um JSON no corpo:

{
  "mensagem": "Retorno recebido com sucesso."
}

✅ O exemplo de payload acima foi corrigido em relação ao documento original do Apiary (havia uma vírgula faltando após numero_remessa_qcertifica).

Callback: Retorno de Status de Operação (`atualizaStatus`)

Padrão de comunicação#

Requisição recebida (Qprof → Cliente)#

Estrutura#

Valores de status_bordero#