API de Conciliação
A conciliação de recebíveis é um processo crítico que envolve a verificação e o alinhamento dos pagamentos recebidos com os valores esperados em uma operação de securitização. Isso assegura a eficiência financeira da operação, protege os interesses dos investidores e mantém a integridade do mercado de capitais.
Troca de dados de conciliação via arquivo
Nosso procedimento se inicia a partir da definição de como será feita a troca de dados de conciliação. Caso seja feita via arquivos, você deve:
Determinar o formato de dado que será transacionado para conciliação, checar as orientações na página troca de dados via arquivo.
Solicitar a criação de um repositório seguro para a troca de informações
Aderir ao nosso programa de segurança para prevenção ao vazamento de dados
Pronto, você já pode iniciar a transferência de dados junto ao nosso time!
Troca de dados de conciliação via API
Produto restrito, para utilizar siga a orientação 🔒
Caso queira apenas utilizar os tópicos disponíveis, verifique a documentação de API a seguir:
Criar carga
POST /v1/carga/criar
Cria uma carga para que seja possível enviar registros para as tabelas temporárias. Todos os demais endpoints da carga necessitam que seja criada a mesma, portanto este é o primeiro endpoint que deve ser consumido.
Headers
Content-Type
application/json
Authorization
Basic <token>
Body
IdCarga
integer
Fixo 0. Este campo será preenchido após a carga ser criada.
NumeroRemessa
integer
Se controla a sequência, então neste campo deve ser informada a mesma, caso contrário informar 0.
Origem
string 30 bytes
Origem da carga é importante para o programa CargaExecucao.
TipoArquivo
integer
Enviar 0 caso seja uma arquivo de carga normal ou 1 caso seja uma carga do tipo batimento.
TipoSequencial
integer
Enviar 1 se não controla sequência ou 0 caso controle a sequência. Caso seja enviado 1 o campo NumeroRemessa tem que conter a sequência do próximo arquivo de carga a ser processado.
nmArquivo
string 500 bytes
Nome do arquivo.
JSON
{
"IdCarga": integer,
"NumeroRemessa": integer,
"Origem": "string 30 bytes",
"TipoArquivo": integer,
"TipoSequencial": integer,
"nmArquivo": "string 500 bytes"
}Response
{
"CargaCriada": {
"sucesso": true,
"carga": {
"IdCarga": 78050,
"Origem": "MODELOCARGA",
"NumeroRemessa": 0,
"DataRemessa": "2025-07-15T15:13:20",
"DataProcessamento": "2025-07-15T15:13:20",
"TipoStatus": 0,
"TipoSequencial": 0,
"DataInicio": "0001-01-01T00:00:00",
"DataFim": "0001-01-01T00:00:00",
"nmArquivo": "ARQUIVO_TESTE.REM",
"TipoArquivo": 0,
"MovimentoResumo": {
"QuantidadeOK": 0,
"QuantidadeErro": 0
},
"Movimento": [],
"Rejeicao": []
}
}
}
Enviar Registro
POST/v1/carga/enviarregistro
Enviar registros para uma carga.
Body
carga
JSON
Caso este objeto não seja enviado a API compreende que é uma importação automática.
IdCarga
integer
Enviar o IdCarga recebido no JSON de retorno do endpoint /v1/carga/criar.
NumeroRemessa
integer
Enviar o NumeroRemessa recebido no JSON de retorno do endpoint /v1/carga/criar.
Origem
string 30 bytes
Enviar a Origem recebido no JSON de retorno do endpoint /v1/carga/criar.
TipoArquivo
integer
Enviar o TipoArquivo recebido no JSON de retorno do endpoint /v1/carga/criar.
TipoSequencial
integer
Enviar o TipoSequencial recebido no JSON de retorno do endpoint /v1/carga/criar.
nmArquivo
string 500 bytes
Enviar o nmArquivo recebido no JSON de retorno do endpoint /v1/carga/criar.
Dívida (Array Opcional) - Inclusão de nova dívida
TpEvento
integer
1 Incluir 2 Alterar 18 Alterar dívida com checagem no carga execução. Quando o 18 é utilizado, a dívida é atualizada para o novo valor e, qualquer TpEvento 2 é ignorado caso chegue no mesmo dia do TpEvento 18.
NmClienteCedente
string 50 bytes
Identificador que será utilizado para o cliente.
NmCedenteCedente
string 50 bytes
Identificador do cedente.
NmContratoCedente
string 50 bytes
Identificador do contrato.
NmProdutoCedente
string 50 bytes
Identificador do produto.
VlDivida
double com 2 casas decimais
Valor da dívida.
DtVencimento
date
Data de vencimento da dívida.
NuPrestacao
integer
Número da prestação.
Dívida Detalhes (Array Opcional)
TpEvento
integer
1 Incluir 2 Alterar 3 Excluir
NmClienteCedente
string 50 bytes
Identificador que será utilizado para o cliente.
NmCedenteCedente
string 50 bytes
Identificador do cedente.
NmContratoCedente
string 50 bytes
Identificador do contrato.
NmProdutoCedente
string 50 bytes
Identificador do produto.
NmDividaCedente
string 50 bytes
Identificador da dívida.
NmDetalhe
string 50 bytes
Descrição do detalhe no cadastro de detalhe.
NmDetalheValor
string 500 bytes
Valor do detalhe.
Dívida Pagamento (Array Opcional) - Baixas
TpEvento
integer
3 Baixa por retirada, 4 Baixa integral por pagamento, 5 Baixa parcial por pagamento, 6 Baixa especial por pagamento, 7 Baixa integral por pagamento e quebra de acordo, 8 Baixa parcial por pagamento e quebra de acordo, 9 Baixa por retirada com quebra de acordo. Mais detalhamento sobre a escolha pode ser analisado abaixo.
NmClienteCedente
string 50 bytes
Identificador que será utilizado para o cliente.
NmCedenteCedente
string 50 bytes
Identificador do cedente.
NmContratoCedente
string 50 bytes
Identificador do contrato.
NmProdutoCedente
string 50 bytes
Identificador do produto.
NmDividaCedente
string 50 bytes
Identificador da dívida.
NmDetalhe
string 50 bytes
Descrição do detalhe no cadastro de detalhe.
NmDetalheValor
string 500 bytes
Valor do detalhe.
As renegociações são uma análise combinada das novas dívidas com as baixadas. Ambas devem ter o mesmo número de contrato como referência.
JSON
{
"carga":{
"IdCarga":integer,
"Origem":"string",
"NumeroRemessa":integer,
"TipoSequencial":integer,
"nmArquivo":"string",
"TipoArquivo":integer
},
"Dividas":[
{
"TpEvento":integer,
"NmClienteCedente":"string",
"NmCedenteCedente":"string",
"NmContratoCedente":"string",
"NmProdutoCedente":"string",
"NmDividaCedente":"string",
"VlDivida":double,
"DtVencimento":"date",
"NuPrestacao":integer
}
],
"DividaDetalhes":[
{
"TpEvento":integer,
"NmClienteCedente":"string",
"NmCedenteCedente":"string",
"NmContratoCedente":"string",
"NmProdutoCedente":"string",
"NmDividaCedente":"string",
"NmDetalhe":"string",
"NmDetalheValor":"string"
}
],
"DividasPagamentos":[
{
"TpEvento":integer,
"NmClienteCedente":"string",
"NmCedenteCedente":"string",
"NmContratoCedente":"string",
"NmProdutoCedente":"string",
"NmDividaCedente":"string"
}
]
}
Response
{
"enviarregistro": {
"sucesso": true
}
}Anular Carga
GETv1/carga/anular/{idCarga}
Anula a carga caso a mesma esteja no status de ImportacaoConcluida ou ErroNaCarga. Uma vez que a carga é anulada ela não será mais importada para as tabelas oficiais do sistema.
Body
IdCarga
Integer
Informar o idCarga que deve ser anulada.
Response
{
"CargaAnulada": {
"sucesso": true,
"carga": {
"IdCarga": 78050,
"Origem": "MODELOCARGA",
"NumeroRemessa": 0,
"DataRemessa": "2025-07-15T15:13:20",
"DataProcessamento": "2025-07-15T15:13:20",
"TipoStatus": 2,
"TipoSequencial": 0,
"DataInicio": "0001-01-01T00:00:00",
"DataFim": "0001-01-01T00:00:00",
"nmArquivo": "ARQUIVO_TESTE.REM",
"TipoArquivo": 0,
"MovimentoResumo": {
"QuantidadeOK": 0,
"QuantidadeErro": 0
},
"Movimento": [],
"Rejeicao": []
}
}
}Finalizar Carga
GETv1/carga/finalizar/{idCarga}
Finaliza a carga das tabelas temporárias. É necessário executar este endpoint para que o sistema saiba que a carga das tabelas temporárias foi finalizada, e que está tudo pronto para importar os registros para as tabelas oficiais do sistema.
Body
IdCarga
Integer
Informar o idCarga que foi retornado no JSON do endpoint /v1/carga/criar.
Response
{
"CargaFinalizada": {
"sucesso": true,
"carga": {
"IdCarga": 78050,
"Origem": "MODELOCARGA",
"NumeroRemessa": 0,
"DataRemessa": "2025-07-15T15:13:20",
"DataProcessamento": "2025-07-15T15:13:20",
"TipoStatus": 1,
"TipoSequencial": 0,
"DataInicio": "0001-01-01T00:00:00",
"DataFim": "0001-01-01T00:00:00",
"nmArquivo": "ARQUIVO_TESTE.REM",
"TipoArquivo": 0,
"MovimentoResumo": {
"QuantidadeOK": 0,
"QuantidadeErro": 0
},
"Movimento": [],
"Rejeicao": []
}
}
}Executar
POST/v1/carga/executar
Carrega as tabelas oficiais do sistema importando os registros das tabelas temporárias. Antes de executar este endpoint deve ter sido executado o endpoint /v1/carga/finalizar/{idCarga} para que a carga fique no status de ImportacaoConcluida.
Body
CargaExecucao
JSON
Somente serão carregados os registros que estiverem na temporária e pertecerem as cargas com a Origem informada no JSON e que estejam no status de ImportacaoConcluida ou ErroNaCarga.
TamanhoBloco
integer
Tamanho do bloco para processamento dos registros. Se enviar 0 (zero) então o tamanho do bloco considerado será de 5000 que é o valor default do programa.
ContratoNovo
string
Define se o cliente deve voltar para o status de um novo cliente quando fizer a carga do contrato. Qualquer valor diferente de N ou S será considerado como S. N não vai ser considerado um novo cliente. S vai ser considerado um novo cliente.
BaixarFaturaEspecial
string
Utilizado na Fatura Pagamentos e define se o valor do pagamento pode ser inferior ao valor da fatura. Qualquer valor diferente de N ou S será considerado como S. N o valor do pagamento não pode ser inferior ao valor da fatura. S o valor do pagamento pode ser inferior ao valor da fatura.
IncluirDividaQuitada
string
Define se deve incluir novamente uma dívida que foi quitada anteriormente. Qualquer valor diferente de N ou S será considerado como N. N rejeita qualquer dívida que faça parte de acordo quitado ou acordo com parcelas pagas. S incluí as dívidas enviadas na carga mesmo que elas façam parte de acordo quitado ou acordo com parcelas pagas. Mais detalhes abaixo.
InserirEventoCliente
string
Insere evento de inclusão ou alteração de cliente. Qualquer valor diferente de N ou S será considerado como N. N não inserir evento. S inserir evento.
InserirEventoContrato
string
Insere evento de inclusão, alteração ou baixa por retirada de contrato. Qualquer valor diferente de N ou S será considerado como N. N não inserir evento. S inserir evento.
InserirEventoDivida
string
Insere evento de dívida. Qualquer valor diferente de N ou S será considerado como N. N não inserir evento. S inserir evento.
InserirEventoDividaPagamento
string
Insere evento de pagamento de dívida. Qualquer valor diferente de N ou S será considerado como N. N não inserir evento. S inserir evento.
Origem
string 15 bytes
Identificador da origem da carga.
InserirPreferencial
string
Selecionar telefone, endereço e e-mail preferêncial. Qualquer valor diferente de N ou S será considerado como S. N não escolher automaticamente o preferêncial. S escolher automaticamente o preferêncial. Mais detalhes abaixo.
AlterarDataAtualizacaoContrato
string
Atualizar a data atualização do contrato que fica em dados do contrato. Qualquer valor diferente de N ou S será considerado como N. N não atualiza quando receber uma atualização de dívida. S atualiza quando receber uma atualização de dívida.
BaixarParcelaAcordoValorPago
string
Baixar a parcela do acordo usando o valor pago informado na carga. Qualquer valor diferente de N ou S será considerado como N. N se o valor pago informado na carga for menor do que o valor da parcela do acordo então usa o valor da parcela do acordo. S utiliza o valor pago informado na carga.
DiasLimiteParaBaixaDeProposta
integer
Na baixa de uma proposta de pagamento a data de pagamento não pode ser superior a data de vencimento da proposta mais os dias limites informados neste parâmetro.
IdUsuarioNoAcordo
integer
Identificador do usuário do acordo para os acordos que estão sendo carregados via carga. Informe 0 (zero) caso não queira utilizar este parâmetro.
ValidarTelefone
string
Executa uma rotina interna do sistema para verificar se o ddd e o telefone estão dentro do padrão que um ddd e um telefone devem possuir. Qualquer valor diferente de N ou S será considerado como N. N não executa a rotina de validação de padrão de ddd e telefone. S executa a rotina de validação de padrão de ddd e telefone.
HabilitarTelefone
string
Habilitar os telefones recebidos na carga que estejam desabilitados. Qualquer valor diferente de N ou S será considerado como N. N não habilita os telefones que foram desabilitados mesmo que recebidos novamente na carga. S habilita todos os telefones que estavam desabilitados se recebidos novamente na carga.
HabilitarEndereco
string
Habilitar os endereços recebidos na carga que estejam desabilitados. Qualquer valor diferente de N ou S será considerado como N. N não habilita os endereços que foram desabilitados mesmo que recebidos novamente na carga. S habilita todos os endereços que estavam desabilitados se recebidos novamente na carga.
ValidarEmail
string
Efetua uma validação interna para consistir um endereço de e-mail. Qualquer valor diferente de N ou S será considerado como S. N não efetua a validação do endereço de e-mail. S efetua a validação do endereço de e-mail.
IgnorarTipoTelefone
string
Na validação se o telefone já existe na base quando este parâmetro estiver com S então não considera o campo TP_TELEFONE. Qualquer valor diferente de N ou S será considerado como N. N considera o campo TP_TELEFONE para validar se o telefone existe na base de dados. S não considera o campo TP_TELEFONE para validar se o telefone existe na base de dados.
ProcessarEmParalelo
string
O programa CargaExecucao faz processamento em pararelo de várias rotinas. Este parâmetro permite desabilitar o processamento em paralelo. Qualquer valor diferente de S ou N será considerado como N. N não executa o processamento da carga em pararelo, ou seja, executa uma rotina por vez. S executa o processamento da carga em paralelo, ou seja, executa várias rotinas daquela carga ao mesmo tempo.
HabilitarEmail
string
Todos os e-mails que vieram na carga e existem na base serão habilitados. Qualquer valor diferente de S ou N será considerado como N. N não habilita os e-mails da base que vieram na carga caso estejam desabilitados. S habilita os e-mails da base que vieram na carga.
RetornarErroExecucaoSimultanea
string
Apresenta um erro de execução caso exista outro CargaExecucao em andamento com a mesma Origem. Qualquer valor diferente de S ou N será considerado como N. N a mensagem de retorno será 0 "PROCESSO EXECUTADO COM SUCESSO." S a mensagem de retorno será 99 "ERRO AO EXECUTAR A ROTINA"
CargaRapidaAcao
string
Executa a carga de ação sem validar as regras do cadastro de ação. Qualquer valor diferente de S ou N será considerado como N. N efetuar todas as validações e procedimentos do cadastro de ação, como agendamento, depósito, etc. S somente carregar a tabela de acionamentos, sem considerar as regras do cadastro de ação como agendamento, depósito, etc.
DesabilitarTelefone
string
Desabilitar da base os telefones que vieram na carga como desabilitados. Qualquer valor diferente de S ou N será considerado como N. N não desabilitar da base os telefones que estão na carga como desabilitados. S desabilitar da base os telefones que estão na carga como desabilitados.
IgnorarOrigemTelefone
string
Os telefones que existem na base e na carga devem possuir a mesma origem de telefone para que sejam atualizados. Qualquer valor diferente de S ou N será considerado como N. N atualiza somente os telefones da base que existam na carga e na base com a mesma origem de telefone. S atualiza os telefones da base que existam na carga e na base, mesmo que a origem do telefone da base seja diferente da origem do telefone na carga.
ValidarAmortizacaoAcordo
string
Na criação do acordo valida a proporcionalização dos valores amortizados em cada parcela do acordo. Qualquer valor diferente de S ou N será considerado como N. N não efetua a validação. S efetua a validação consistindo os valores originais e das parcelas do acordo.
Tarefa
JSON
Descrição da tarefa para facilitar a identificação da mesma na tela de execuções. string 50 bytes
JSON
{
"CargaExecucao":{
"TamanhoBloco":integer,
"ContratoNovo":"string",
"BaixarFaturaEspecial":"string",
"IncluirDividaQuitada":"string",
"InserirEventoCliente":"string",
"InserirEventoContrato":"string",
"InserirEventoDivida":"string",
"InserirEventoDividaPagamento":"string",
"Origem":"string",
"InserirPreferencial":"string",
"AlterarDataAtualizacaoContrato":"string",
"BaixarParcelaAcordoValorPago":"string",
"DiasLimiteParaBaixaDeProposta":integer,
"IdUsuarioNoAcordo":integer,
"ValidarTelefone":"string",
"HabilitarTelefone":"string",
"HabilitarEndereco":"string",
"ValidarEmail":"string",
"IgnorarTipoTelefone":"string",
"ProcessarEmParalelo":"string",
"HabilitarEmail":"string",
"RetornarErroExecucaoSimultanea":"string",
"CargaRapidaAcao":"string",
"DesabilitarTelefone":"string",
"IgnorarOrigemTelefone":"string",
"ValidarAmortizacaoAcordo":"string"
},
"Tarefa":{
"DescricaoTarefa":"string"
}
}Response
{
"executar": {
"sucesso": true
}
}Movimento
POST /v1/carga/movimento
Retorna o movimento da carga.
Body
IdCarga
integer
Informar o idCarga que deseja obter o movimento.
RetornarMovimento
boolean
Retorna ou não o objeto de movimento.
RetornarRejeicao
boolean
Retorna ou não o objeto de rejeição.
JSON
{
"IdCarga": integer,
"RetornarMovimento": boolean,
"RetornarRejeicao": boolean
}Atualizado
Isto foi útil?