Remessa XML
Abaixo os arquivos que você pode usar para guiar seu desenvolvimento.:
Estrutura Arquivo XML
POST http://host/api/integracao/remessas/xml
Parameters
host
Homologação: https://hom.api.hmra.com.br
Produção: https://api.hmra.com.br
REQUEST
Attributes
NumeroControle | string | Id externo sequencial / número de controle do parceiro (também obrigatório para CCB endossada via CertficaQI)
Identificacao | required | string | Fixo "LAYOUT001"
DataGeracao | required | number | Data atual - Formato: "DD/MM/AAAA"
Fundo | required | object | Conjunto de informações referente ao Fundo
CNPJ | required | string | Preencher com o CNPJ do Fundo. Formato: 99.999.999/9999-99
Nome | required | string | Preencher com a Razão social do Fundo.
CNPJCustodiante | required | string | Preencher com o CNPJ do Custodiante. Formato: 99.999.999/9999-99
Instrucoes | required | object
Aqusicoes | array
Aquisicao | object | Objeto da Aquisição
Cedente | required | object
TipoPessoaMF | required | enum
- F = Pessoa Física
- J = Pessoa Jurídica
CPFCNPJ | required | string | Preencher com o CNPJ ou CPF. Formato: CNPJ: 99.999.999/9999-99 - CPF: 999.999.999-99
Nome | required | string | Preencher com a Razão Social (Pessoa Jurídica) ou Nome (Pessoa Física) do Cedente
Coobrigacao | required | enum | Preencher de acordo com o Contrato de Promessa de Cessão assinado
- 01 = Com coobrigação
- 02 = Sem coobrigação
Formalizacao | object
CodigoManifestacaoVontade | string | Formalização da Cessão - Código Único por Remessa - Não aceita repetição
Titulos | array
Titulo | required | object
Sacado | required | object | Conjunto de informações referente ao Sacado
TipoPessoaMF | required | enum
- F = Pessoa Física
- J = Pessoa Jurídica
CPFCNPJ | required | string | Preencher com o CNPJ ou CPF. Formato: CNPJ: 99.999.999/9999-99 - CPF: 999.999.999-99
Nome | required | string | Preencher com a Razão Social (Pessoa Jurídica) ou Nome (Pessoa Física) do Sacado
Endereco | required | object
CEP | required | string | Preencher com o CEP do Sacado - "99999-999"
Logradouro | required | string | Preencher com o logradouro do Sacado (somente logradouro, sem números ou complemento)
Numero | required | number | Preencher com o número do imóvel. Utilize 0 para sem número
Complemento | string | Preencher com o complemento do endereço
Bairro | string | Preencher com o bairro
Municipio | required | string | Preencher com o município
UF | required | string | Preencher com a sigla da Unidade Federativa
CNPJEmpresaConveniada | string | Obrigatório quando o Tipo de Ativo for CCB "04" E o Sub Tipo Ativo for Empréstimo Consignado – Privado "01" OU Empréstimo Consignado – Público "02". Preencher com CNPJ do Ente Consignante - Ao informar este dado será exigido que o sacado tenha vinculo com a empresa conveniada. Formato: 99.999.999/9999-99
DadosTitulos | required | object
TipoAtivo | required | enum | Informar o código do ativo
01 = Duplicata Mercantil
02 = Cheques
03 = Contratos
04 = Cédula de Crédito Bancário
13 = Nota de Serviço
14 = Cartão de Crédito (NSU)
16 = Cédula do Produtor Rural
19 = Duplicata de serviço
25 = Cartão de Crédito (Unidade Recebível - Registradora)
28 = Direito de Indenização
29 = Acordo Judicial
30 = Título Precatório
31 = Nota Comercial
37 = Cartão de Crédito do Adquirente (Banco Liquidante)
43 = Conhecimento de Transporte
NumeroBoletoBanco | required | string | OBRIGATÓRIO se a geração de cobrança for feita pelo custodiante. Para emissão do boleto pela cedente preencher com o número do boleto sem o DV. ZERO para a emissão pelo banco
NumeroControleParticipante | required | string | Preencher com a identificação do título na consultora - Não aceita repetição. Código único por Fundo - Para operação de fluxo financeiro preencher com o "Numero do ativo" + "Número da parcela" + "/" + "Total de parcelas" - Limitado a 25 caracteres. Não utilizar underline.
StatusAtivo | required | enum | Preencher com o status do ativo
- 01 = Performado
- 02 = A Performar
NumeroDocumento | required | string | Preencher com o número do título atribuído pela cedente
CMC7 | string | Preencher com o CMC7 do cheque (apenas para remessa de cheque)
DataEmissao | required | string | Preencher com a data de emissão do título. Formato: DD/MM/AAAA
DataAquisicao | required | string | Preencher com a data de aquisição do título. Formato: DD/MM/AAAA
DataVencimento | required | string | Preencher com a data de vencimento do título. Formato: DD/MM/AAAA
ValorPresente | required | number | Preencher com o valor presente do título. Formato: 99999999999.99
ValorNominal | required | number | Preencher com o valor nominal do título. Formato: 99999999999.99
Especie | required | enum | Informar o código do ativo
TipoOperacao | required | enum
01 = PRÉ
02 = PÓS
03 = PÓS + PRÉ
Indexador | number | Preencher com o indexador da operação
ValorCorrecaoIndexador | number | Obrigatório se taxa pós. Preencher com o valor percentual da correção diária (dias úteis). Formato 99999.99
TaxaPre | number | Preencher com a taxa prefixada. Formato 999.99
TaxaMultaBoleto | number | Obrigatório se a geração de cobrança for feita pelo custodiante. Preencher com a taxa da multa em caso de atraso. Formato 999.99
MoraDiaria | number | Obrigatório se a geração de cobrança for feita pelo custodiante. Preencher com o valor da mora por dia de atraso. Formato 99999999999.99
ImpressaoBoleto | enum | Obrigatório se a geração de cobrança for feita pelo custodiante
01 = Banco
02 = Cedente
ValorDataAquisicao | number | Obrigatório para CCB formalizada via ClickSign - Valor total da aquisição da CCB. Formato 99999999999.99
ValorTotalEmprestimo | number | Obrigatório para CCB formalizada via ClickSign - Valor total do empréstimo. Formato 99999999999.99
RegistroCobranca | enum | Obrigatório se a geração de cobrança for feita pelo custodiante. Informar se o título vai ser registrado no banco cobrador
S = Sim, o título vai ser registrado na Cobrança
N = Não - Não precisa informar o elemento CobrancaBancaria
CobrancaBancaria | object | Obrigatório se a geração de cobrança for feita pelo custodiante. Informar se o título vai ser registrado no banco cobrador
BancoCobranca | required | number | Preencher com o código do banco da cobrança. Formato: 999
AgenciaCobranca | required | number | Preencher com o código da agencia da cobrança. Formato: 9999
DvAgenciaCobranca | required | number | Preencher com o DV da agencia da cobrança. Formato: 9
ContaCobranca | required | number | Preencher com o numero da conta da cobrança. Formato: 9999999
DvContaCobranca | required | number | Preencher com o DV da conta da cobrança. Formato: 9
CarteiraCobranca | required | number | Preencher com o código da carteira (ativa na conta informada) de cobrança. Formato: 999
ValorAbatimento | required | number | Preencher com o valor do abatimento que será cedido ao título. Formato: 99999999999.99
ValorIOF | required | number | Preencher com o valor do IOF. Formato: 99999999999.99
Instrucao1 | required | enum | Campo destinado a determinar protesto, baixa por decurso de prazo e inclusao de mesangens nos boletos. Formato 99
00 = Sem instrução
05 = Protesto Falimentar
06 = Protestar
08 = Não cobrar juros de mora
09 = Não receber após o vencimento
10 = Multa de 10% após o 4º dia do Vencimento
11 = Não receber após o 8º dia do vencimento
12 = Cobrar encargos após o 5º dia do vencimento
13 = Cobrar encargos após o 10º dia do vencimento
14 = Cobrar encargos após o 15º dia do vencimento
15 = Conceder desconto mesmo se pago após o vencimento
18 = Decurso de prazo
Intrucao2 | number | Preencher com o número de dias para protesto (conforme banco cobrador e código informado no campo Instrucao1). Formato: 99
ConcessoesDesconto | object
DataLimite | required | number | Preencher com a data limite para concessao de desconto. Formato: DD/MM/AAAA
ValorDesconto | required | number | Preencher com o valor do desconto que será cedido ao título. Formato: 99999999999.99
Mensagens | array | Conjunto de informaçãos referentes as mensagens impressas no boleto
Mensagem | object
ID | required | number | Preencher o numero da mensagem - De 1 a 3
Descricao | required | string | Preencher com a mensagem que deverá ser impressa no boleto (40 caracteres)
CPFCNPJOriginador | string | Preencher com o CNPJ do Originador do título. Formato: 999.999.999-99 ou 99.999.999/9999-99
ConvenioOriginacao | string | Preencher com o código do canal de origem da operação. (30 caracteres)
SubTipoAtivo | enum | Obrigatório quando o Tipo de Ativo for CCB "04"
01 = Emprestimo Consignado - Privado
02 = Emprestimo Consignado - Público
03 = Aposentadoria INSS
04 = Empréstimo Pessoal
05 = Capital de Giro - Curto Prazo
06 = Capital de Giro - Longo Prazo
07 = Saque Aniversário - FGTS
08 = Outros
IPOC | string | Obrigatório quando o Tipo de Ativo for CCB "04" - (100 caracteres)
Lastros | object
Lastro | object
ValorTotalLastro | required | number | Preencher com o valor total dos lastros. Formato: 99999999999.99
Documento | required | object
TipoDocumento | required | enum | Preencher com o tipo do documento de lastro
01 = NFe Nota Fiscal Eletrônica
02 = NFCe Nota Fiscal do Consumidor Eletrônica
03 = NFSe Nota Fiscal de Serviços Eletrônica
04 = CTe Conhecimento de Transporte Eletrônico
05 = Cartões Meios de Pagamentos Eletrônicos
06 = Contratos
LastroId | required | string | Preencher com o identificador do lastro
NumeroDocumento | required | string | Preencher com o número do documento
ChaveDocumento | string | Preencher com a chave do documento fiscal(NF-e). Obrigatório para casos de documento fiscal eletrônico
ValorTotalDocumento | required | number | Preencher com o valor total do documento. Formato: 99999999999.99
NSU | string | NÃO PREENCHER QUANDO ATIVO UR - Preencher o código NSU quando a operação for para ativo Cartão de Crédito.
ModoCaptura | enum | Preencher o Modo de captura quando a operação for para ativo Cartão de Crédito.
1 = Chip E Pin
2 = Magnetic Stripe Reader
3 = BarCode
4 = Optical Character Recognition (OCR)
5 = Integrated Circuit Card 1
7 = Proximity Payment Using ICC Data
80 = ICC Fallback To Magnetic Stripe
81 = Electronic Commerce
90 = Complete contents of magnetic stripe, track 2 have been read and checked
91 = Proximity payment using magnetic stripe data
UR | object | OBRIGATÓRIO se Ativo do Tipo UR
Credenciadoras | required | array
CNPJ | required | string | CNPJ da Credenciadora ou Subcredenciadora. Formato: 99.999.999/9999-99
DocumentoUsuarioFinalRecebedorOuTitular | required | string | Formato: 999.999.999-99 ou 99.999.999/9999-99
ReferenciaExterna | required | string | Código de referência de controle do participante.
IdentificadorContrato | required | string | Código de identificação do contrato nos controles do participante.
Alcancada | required | object
CnpjCredenciadora | required | string | CNPJ da Credenciadora ou Subcredenciadora. Formato: 99.999.999/9999-99
TipoDocumentoUsuarioFinalRecebedor | required | enum
1 = CPF
2 = CNPJ
DocumentoUsuarioFinalRecebedor | required | string | CNPJ ou CPF do usuário final recebedor. Formato: 999.999.999-99 ou 99.999.999/9999-99.
DocumentoTitular | string | CNPJ ou CPF do titular. Formato: 999.999.999-99 ou 99.999.999/9999-99.
CodigoArranjoPagamento | enum | Formato "AAA"
ACC = Amex Cartão de Crédito
AGC = Agiplan Cartão de Crédito
AUC = Aura Cartão de Crédito
AVC = Avista Cartão de Crédito
BCC = Banescard Cartão de Crédito
BCD = Banescard Cartão de Débito
BNC = Banese Crédito
BRC = Brasil Card Cartão de Crédito
BRS = Banrisul (Compra)
BVV = Ben Visa Vale
CAC = Cielo Amex Crédito
CBC = Cabal Crédito
CBD = Cabal Débito
CCD = Calcard Cartão de Crédito
CSC = Credi-Shop Cartão de Crédito
CUP = CUP Cartão de Crédito
CZC = Credz Cartão de Crédito
DAC = Dacasa Cartão de Crédito
DBC = Discover Cartão de Crédito
DCC = Dinners Cartão de Crédito
ECC = Elo Cartão de Crédito
ECD = Elo Cartão de Débito
FRC = Fortbrasil Cartão de Crédito
GCC = Goodcard Crédito
HCC = Hipercard Cartão de Crédito
HCD = Hipercard Cartão de Débito
JCC = JCB Cartão de Crédito
MAC = Mais Cartão de Crédito
MCC = Mastercard Cartão de Crédito
MCD = Mastercard Cartão de Débito
MXC = Maxifrota Cartão de Crédito
OCD = Ourocard Cartão de Débito
RCC = Redesplan Cartão de Crédito
SCC = Sorocred Cartão de Crédito
SCD = Sorocred Cartão de Débito
SFC = Senff Cartão de Crédito
SIC = Sicred (Compra)
SPC = Sem Parar Cartão de Crédito
TKC = Ticketlog Pós Cartão de Crédito
VCC = Visa Cartão de Crédito
VCD = Visa Cartão de Débito
VDC = Verdecard Cartão de Crédito
DataLiquidacao | required | string | Data de liquidação do recebível prevista pelo arranjo de pagamento ou com efeitos da antecipação pré-contratada
Constituicao | enum
ValorConstituidoTotal | number | Valor constituído total da unidade de recebível. Formato: 9999.99
ValorBloqueado | number | Valor bloqueado para pagamento na unidade de recebível. Formato: 9999.99
IndicadorOneracao | string | Identificador sequencial que indica a prioridade do ônus
RegraDivisao | enum | Obrigatório para compra parcial de uma UR
1 = Constituida
2 = A Constituir
1 = Comprometimento de valor definido
2 = Comprometimento de percentual do valor que vier a ser constituído
ValorOnerado | number | Obrigatório para compra parcial de uma UR
Recompra | array
Recompra | object | Objeto da Recompra
Cedente | required | object
TipoPessoaMF | required | enum
- F = Pessoa Física
- J = Pessoa Jurídica
CPFCNPJ | required | string | Preencher com o CNPJ ou CPF. Formato: CNPJ: 99.999.999/9999-99 - CPF: 999.999.999-99
Nome | required | string | Preencher com a Razão Social (Pessoa Jurídica) ou Nome (Pessoa Física) do Cedente
Titulos | array
Titulo | required | object
TipoAtivo | required | enum | Informar o código do ativo
01 = Duplicata Mercantil
02 = Cheques
03 = Contratos
04 = Cédula de Crédito Bancário
10 = Contrato Físico
13 = Nota de Serviço
16 = Cédula do Produtor Rural
19 = Duplicata de serviço
21 = Fatura
25 = Unidade Recebível(Cartão de Crédito)
28 = Direito de Indenização
29 = Acordo Judicial
30 = Título Precatório
31 = Nota Comercial
37 = Cartão de Crédito do Adquirente
43 = Conhecimento de Transporte
NumeroTitulo | string | Número do boleto registrado na cobrança
NumeroControleParticipante | required | string | Preencher com a identificação do título na consultora - Mesma informação envida na aquisição do título
NumeroDocumento | required | string | Preencher com o número do título atribuído pela cedente
CMC7 | string | Preencher com o CMC7 do cheque (apenas para remessa de cheque)
DataVencimento | required | string | Preencher com a data de vencimento do título. Formato: DD/MM/AAAA
ValorNominal | required | number | Preencher com o valor nominal do título. Formato: 99999999999.99
MotivoRecompra | string | Preencher com o motivo da recompra
ValorRecompra | required | number | Valor da recompra do título (O valor não pode ser menor que o de aquisição). Formato: 99999999999.99
Sacado | required | object | Conjunto de informações referente ao Sacado
TipoPessoaMF | required | enum
- F = Pessoa Física
- J = Pessoa Jurídica
CPFCNPJ | required | string | Preencher com o CNPJ ou CPF. Formato: CNPJ: 99.999.999/9999-99 - CPF: 999.999.999-99
Nome | required | string | Preencher com a Razão Social (Pessoa Jurídica) ou Nome (Pessoa Física) do Sacado
Pagamentos | required | array
PagamentoCessao | object
CPFCNPJ | required | string
CodigoBanco | required | number | Preencher com o código do banco para pagamento da cessão. Formato: 999
CodigoAgencia | required | number | Preencher com o código do agencia para pagamento da cessão. Formato: 9999
dvAgencia | required | number | Preencher com o DV da agencia para pagamento da cessão. Formato: 9
Conta | required | number | Preencher com o numero da conta para pagamento da cessão. Formato: 99999999999
dvConta | required | number | Preencher com o DV da conta para pagamento da cessão. Formato: 9
ValorTransacao | required | number | Preencher com o valor total do pagamento da cessão (valor que será pago ao cedente). Formato: 99999999999.99
Instrução de Compra
- <Remessa>
<Identificacao>
<DataGeracao>
+ <Fundo>
<CNPJCustodiante>
- <Instrucoes>
+ <Aquisicoes>
+ <Pagamentos>
Instrução de Compra com Recompra
- <Remessa>
<Identificacao>
<DataGeracao>
+ <Fundo>
<CNPJCustodiante>
- <Instrucoes>
+ <Aquisicoes>
+ <Recompra>
+ <Pagamentos>
01 = Duplicata Mercantil
02 = Cheques
03 = Contratos
04 = Cédula de Crédito Bancário
13 = Nota de Serviço
14 = Cartão de Crédito (NSU)
16 = Cédula do Produtor Rural
19 = Duplicata de serviço
25 = Cartão de Crédito (Unidade Recebível - Registradora)
28 = Direito de Indenização
29 = Acordo Judicial
30 = Título Precatório
31 = Nota Comercial
37 = Cartão de Crédito do Adquirente (Banco Liquidante)
43 = Conhecimento de Transporte
Exemplos XML - Os dados do XML abaixo servem apenas para exemplo. Preencha com os dados corretos e como exigido na documentação.
Remessa de Compra com Amortização
Remessa de Compra com Recompra e Amortização
Retorno da API de Remessas:
Sucesso:
{
"mensagem": "Remessa recebida com sucesso. Aguarde validação e processamento.",
"remessaId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"remessaIdentificador": "MTQ1NzUxOTg=",
"erros": null
}
Erro:
{
"mensagem": "Erro durante a validação do objeto.",
"remessaId": null,
"remessaIdentificador": null,
"erros": [
{
"codigo": 100,
"campo": "Data",
"descricao": "Data de Geração não pode ser diferente da data de hoje."
}
]
}
Instrução de Compra com Amortização
- <Remessa>
<Identificacao>
<DataGeracao>
+ <Fundo>
<CNPJCustodiante>
- <Instrucoes>
+ <Aquisicoes>
+ <Amortizacao>
+ <Pagamentos>
Instrução de Compra com Recompra e Amortização
- <Remessa>
<Identificacao>
<DataGeracao>
+ <Fundo>
<CNPJCustodiante>
- <Instrucoes>
+ <Aquisicoes>
+ <Recompra>
+ <Amortizacao>
+ <Pagamentos>
Amortizacoes| array
Amortizacao | object | Objeto da Amortização
Cedente | required | object
TipoPessoaMF | required | enum
- F = Pessoa Física
- J = Pessoa Jurídica
CPFCNPJ | required | string | Preencher com o CNPJ ou CPF. Formato: CNPJ: 99.999.999/9999-99 - CPF: 999.999.999-99
Nome | required | string | Preencher com a Razão Social (Pessoa Jurídica) ou Nome (Pessoa Física) do Cedente
Titulos | array
Titulo | required | object
TipoAtivo | required | enum | Informar o código do ativo
01 = Duplicata Mercantil
02 = Cheques
03 = Contratos
04 = Cédula de Crédito Bancário
10 = Contrato Físico
13 = Nota de Serviço
16 = Cédula do Produtor Rural
19 = Duplicata de serviço
21 = Fatura
25 = Unidade Recebível(Cartão de Crédito)
28 = Direito de Indenização
29 = Acordo Judicial
30 = Título Precatório
31 = Nota Comercial
37 = Cartão de Crédito do Adquirente
43 = Conhecimento de Transporte
NumeroTitulo | string | Preencher com o número do título atribuído pela cedente
NumeroControleParticipante | required | string | Preencher com a identificação do título na consultora - Mesma informação envida na aquisição do título
CMC7 | string | Preencher com o CMC7 do cheque (apenas para remessa de cheque)
DataVencimento | required | string | Preencher com a data de vencimento do título. Formato: DD/MM/AAAA
ValorNominal | required | number | Preencher com o valor nominal do título. Formato: 99999999999.99
ValorAmortizacao | required | number | Valor da amortização do título (O valor não pode ser maior ou igual ao nominal). Formato: 99999999999.99
Sacado | required | object | Conjunto de informações referente ao Sacado
TipoPessoaMF | required | enum
- F = Pessoa Física
- J = Pessoa Jurídica
CPFCNPJ | required | string | Preencher com o CNPJ ou CPF. Formato: CNPJ: 99.999.999/9999-99 - CPF: 999.999.999-99
Nome | required | string | Preencher com a Razão Social (Pessoa Jurídica) ou Nome (Pessoa Física) do Sacado