Callback
O Callback é uma ferramenta que dispara requisições POST a uma URL definida pelo cliente. Essa requisição é disparada a cada alteração do status da Remessa, Pré-Cadastro e Cadastro de Agentes. Ao realizar a configuração do mesmo, o sistema enviará todos os eventos ao destinatário. No detalhamento do endpoint há a descrição dos objetos utilizados para o envio dos Status da Remessa e do Cadastro.
Solicitar configuração
Para solicitar a configuração do disparo do callback para o seu endpoint é necessário enviar um email para produtos@hemeradtvm.com.br, com o assunto "Configurar endereço callback - [ambiente(Produção/Homologação)]" e no corpo do mesmo qual Handshake será utilizado para fazer o envio dos eventos. Este processo não fará autenticação no enpoint. Para garantir a segurança da informação você tem que aceitar apenas posts dos ips que forneceremos na resposa da sua solicitação. É possível ter endpoints diferentes para cada tipo (REMESSA e CADASTRO). Informe na requisição os endpoints que deseja utilizar.
Status Pré-Cadastro
Status Cadastro
Status Remessa
REQUEST
Attributtes
Headers
Accept: application/json
Content-Type: application/json
BODY
Corpo da Requisição (Cadastro):
{
"ReturnCode": 0,
"ReturnType": "CADASTRO",
"Statuses": [{
"codigo": 99999,
"data_criacao": "2021-02-22T01:03:46.53",
"descricao": "Cadastro pendente",
"cpf_cnpj": "999.999.999-99",
"cpf_alterador": "SISTEMA",
"nome_alterador": null,
"status": "CADASTRO_PENDENTE"
}]
}
Corpo da Requisição (Remessa):
{
id_unico: "XXXXXX", — código do campo remessaIdentificador retornado no envio de Remessa,
"RequesterID": 99,
"ReturnType": "REMESSA",
"NumeroControle": "ABCD1234i" - código externo, enviado pelo parceiro, na tag <NumeroControle> da Remessa via XML,
"retorno": 0,
"status": [{
"codigo": 99999,
"status": "STATUS_REMESSA_TERMO_CEDENTE_ASSINADO",
"data_criacao": "2021-02-22T15:14:12.5",
"descricao": "Fluxo de assinaturas de CEDENTE de termo concluído.",
"cpf_alterador": "SISTEMA",
"nome_alterador": null
}, {
"codigo": 999998,
"status": "STATUS_REMESSA_TERMO_INFO_ADM",
"data_criacao": "2021-02-22T15:14:12.917",
"descricao": "Pendente de Assinaturas do ADMINISTRADOR",
"cpf_alterador": "SISTEMA",
"nome_alterador": null
}],
"erros": [],
"errosRegra": [],
"Detalhamento": []
}