Tote
HomeAPIsGuiasRelease Notes
HomeAPIsGuiasRelease Notes
Fale conosco
  1. Serviços Bancários
  • Diretrizes Básicas
  • Autenticação
    • Autenticação
  • Acheron
    • Pagamento
      • Cadastrar um pagamento
      • Cancelar um pagamento
      • Criar intenção de pagamento
      • Confirmar intenção de pagamento
      • Cancelar intenção de pagamento
      • Listar intenções de pagamento
      • Criar pagamento via PIX
    • Venda
      • Criar venda com cartão
      • Cancelar venda com cartão
      • Criar venda com portador
      • Cancelar venda com portador
      • Estornar uma venda
    • E-Commerce
      • Criar venda e-commerce
      • Confirmar pagamento e-commerce
      • Listar pagamento e-commerce
      • Cancelar venda e-commerce
      • Gerar token de e-commerce
    • VTEX
      • Criar venda VTEX
      • Confirmar venda VTEX
      • Estornar venda VTEX
      • Cancelar venda VTEX
      • Listar manifesto do provedor de pagamento
    • Simulação
      • Criar simulação
    • Pré-autorização
      • Listar pré-autorização
      • Cancelar valor reservado
      • Listar valor reservado
    • BNPL
      • Confirmar estorno de venda
      • Estornar venda
      • Simular venda
      • Confirmar venda
      • Sensibilizar venda
  • Agenda lojista
    • Agenda
      • Cadastrar recebimento em agenda
      • Cadastrar agenda manual
      • Listar agenda por loja
      • Consultar agenda específica
      • Listar transações pelo ID da agenda ou loja
    • Configurações de Agendas
      • Cadastrar configuração
      • Listar configurações da agenda
      • Alterar configuração de uma loja
    • Modalidade
      • Cadastrar modalidades
      • Listar modalidades
      • Listar modalidade por lançamento
      • Alterar tipo de modalidade
    • Lançamentos
      • Listar lançamentos por loja
      • Cadastrar lançamentos
      • Cadastrar lançamento de ajuste
    • Tipo de ajuste
      • Cadastrar um tipo de ajuste
      • Listar tipo de ajuste
  • Banking
    • Conciliação bancária
      • Gerar saldo para um emissor
      • Gerar extrato para um emissor
      • Gerar arquivos de conciliação
    • Contas
      • Listar contas digitais
    • Pix
      • Transferir pix
      • Listar status do pix
      • Listar transferências Pix
      • Listar informações de chave
  • Biometria
    • Biometria
    • Handshake fortface
      • Iniciar o processo de autenticação biométrica SDK
      • Iniciar o processo de autenticação biométrica Backoffice
    • Biometria
      • Identificar um rosto
      • Cadastrar uma face utilizando o SDK Fortface
      • Cadastrar uma face através do Backoffice da Fortface
  • Broker
    • Enviar mensagem SMS
  • Cartões
    • Portadores
      • Buscar cartão pelo titular
      • Cadastrar portador adicional
      • Listar cartões do adicional
      • Gerar cartão adicional
    • CVV Virtual
      • Ativar CVV Virtual do titular
      • Inativar CVV Virtual
      • Atualizar data de expiração do CVV
    • Senha
      • Cadastrar senha
      • Alterar senha
      • Autenticar senha do cartão
      • Gerar senha e enviar por SMS
    • Bloqueios e Desbloqueios
      • Bloquear um cartão temporariamente
      • Bloquear permanentemente
      • Listar histórico de bloqueios
      • Listar tipos de bloqueio
      • Desbloquear cartão
    • Cartões
      • Solicitar segunda via
      • Trocar cartão pendente
      • Buscar cartão criptografado
      • Listar histórico de cancelamento
      • Listar tipos de cancelamento
      • Gerar um cartão virtual
      • Listar cartão virtual
      • Buscar cartão pelo id
      • Buscar cartão pelo número
      • Buscar cartão pelo CPF
      • Buscar cartão bandeirado
      • Token Merci
      • Trocar cartão do portador
      • Cadastrar Pessoa Jurídica
      • Solicitar troca do cartão
      • Listar BIN
    • No Name
      • Listar lotes de cartão
      • Criar lote de cartões
      • Destruir cartão
      • Vincular cartão ao titular
      • Vincular cartão adicional
      • Destruir lote de cartões
      • Embossar cartões por lote
      • Listar cartões
    • Vipagem
      • Listar cartões bandeirados
      • Emitir segunda via
  • Embossing
    • Cartões
      • Embossing de cartão
      • Bloquear cartão por falha
      • Listar cartões pendentes
    • Impressoras
      • Inativar impressora
      • Ativar impressora
  • Empréstimo
    • Empréstimo Pix Card
      • Enviar arquivo
      • Alterar dados bancários
      • Transferir via Pix
      • Cadastrar pessoa física
      • Simular empréstimo
      • Confirmar empréstimo
      • Aprovar crédito
      • Criar contrato
      • Consultar pessoa
    • Empréstimo FGTS
      • Simular saldo
      • Obter saldo
      • Cadastrar pessoa física
      • Cadastrar operação
      • Submeter para aprovação
      • Consultar informações
      • Listar produto
      • Consultar pessoa
      • Listar operações
      • Acompanhar operação
      • Listar estado civil
      • Listar bancos
  • Faturamentos
    • Parcelamento de fatura
      • Antecipar uma parcela do parcelamento
      • Antecipar todo o parcelamento
      • Buscar parcelamento pendente
      • Buscar parcelamento ativo
      • Simular antecipação
      • Parcelar faturas
    • Ciclos de fatura
      • Consultar ciclos de vencimento
      • Alterar o ciclo de vencimento
    • Consulta de faturas
      • Consultar lançamentos futuros
      • Consultar faturas por período
      • Consultar faturas futuras
      • Consultar última fatura fechada
      • Consultar fatura detalhada
      • Consultar fatura atual
      • Visualizar saldo detalhado
    • Faturas digitais
      • Receber fatura em PDF
      • Aderir à fatura digital
      • Cancelar fatura digital
      • Aderir à fatura por SMS
      • Cancelar fatura por SMS
  • Financiamentos
    • Parcelamento total
      • Simular parcelamento devedor total
    • Parcelamento manual
      • Simular parcelamento manual
  • Gestão de contas
    • Cadastrar cartão físico para titular
  • Lançamentos
    • Ajustes
      • Lançar um ajuste financeiro
      • Listar um ajuste financeiro
      • Lançar ajustes a débito
      • Lançar ajustes a crédito
      • Listar tipos de ajustes
      • Listar faturas ajustadas
      • Lançar um ajuste na fatura
    • Vendas
      • Antecipar venda total
      • Antecipar venda avulsa
    • Pagamentos
    • Antecipação
      • Listar compras passíveis de antecipação
    • Baixas bancárias
      • Estornar lançamento de baixa bancária
      • Lançar baixa báncaria
      • Lançar baixa bancária de pagamento
      • Estornar pagamento de baixa bancária
  • Loja
    • Formas de Pagamentos
      • Listar formas de pagamento
      • Cadastrar forma de pagamento
      • Atualizar forma de pagamento
      • Consultar parcelas de uma loja
    • Tarifas
      • Listar tarifas
      • Cadastrar tarifa
      • Associar tarifa a uma loja
      • Cancelar tarifas com a loja
      • Listar tarifas por loja
      • Consultar uma tarifa
      • Alterar cadastro de uma tarifa
    • Lojas
      • Cadastrar uma loja
      • Consultar uma loja
      • Consultar loja por id externo
      • Listar loja pelo CNPJ
      • Listar lojas
      • Alterar uma loja
  • Pacote SMS
    • Contratar um pacote SMS
    • Cancelar um pacote SMS
    • Consultar pacotes do portador
    • Habilitar celular para adesão do pacote
    • Habilitar celular para receber bônus
    • Consultar pacotes disponíveis
    • Consultar pacotes contratados
  • Parâmetros
    • Listar parâmetros cadastrados
    • Listar parâmetros exibíveis
  • Pix
    • Pix Imediato
      • Listar chaves Pix Imediato
      • Gerar Pix Imediato
      • Listar uma chave Pix Imediato
  • Pix Card
    • PixCard
      • Transferir via Pix
      • Consultar CPF
      • Cadastrar cliente
      • Simular operação
      • Confirmar operação
      • Cadastrar documento do portador
    • Assinatura
      • Listar as assinaturas
      • Cadastrar assinatura
      • Verificar assinaturas para cobrança
      • Listar assinaturas válidas
      • Listar planos
      • Alterar assinatura pelo CPF
    • Conta Digital
      • Listar termos obrigatórios
      • Cadastrar termo obrigatório
      • Cadastrar documento do portador
      • Criar uma conta digital
      • Criar uma conta alias
      • Listar contas pelo identificador
      • Listar informações do portador
    • Transferência
      • Agendar transferência
      • Efetuar transferência
      • Listar status de transferência
      • Listar devoluções
      • Listar transferências
      • Listar agendamentos de transferências
    • Relatórios
      • Listar operações
      • Listar relatórios de assinaturas
      • Listar adesões
    • QR Code
      • Criar QR Code estático
      • Decodificar QR Code
    • Chaves
      • Confirmar reivindicações
      • Fazer reivindicação
      • Cadastrar chave
      • Deletar chave
      • Listar chaves
      • Consultar chaves pelo identificador
      • Listar reivindicações
    • Limites
      • Criar limite de horário
      • Associar conta a grupo de serviço
      • Listar destinos confiáveis
      • Alterar limite do destino confiável
      • Listar limites de horários
      • Listar requisições
      • Remover destino confiável
  • Portadores
    • Gestão de portadores
      • Listar status do portador pelo CPF
      • Listar portadores
      • Alterar dados do portador
      • Alterar status de ativo problemático
      • Listar informações do portador
      • Alterar o limite do portador
      • Bloquear um portador
      • Desbloquear um portador
      • Listar adicionais pelo CPF
      • Listar portadores em lote
      • Listar contas pelo CPF (simplificado)
      • Listar contas pelo CNPJ
      • Alterar produto do portador
      • Listar contas pelo documento
      • Listar contas pelo RG
      • Listar contas pelo nome
      • Alterar vipagem
      • Consultar ciclo do portador
      • Listar contas pelo CPF (completo)
    • Gestão de dependentes
      • Listar dependentes pelo titular
      • Cadastrar dependentes
    • Gestão de telefones
      • Listar telefones
      • Cadastrar telefone
      • Deletar telefone
      • Receber SMS
    • Visualização de histórico
      • Listar histórico do portador
      • Listar ocorrências
      • Listar inadimplências pelo portador
      • Listar o histórico de limites
    • Gestão de senhas
      • Enviar senha por SMS
      • Alterar senha do portador
    • Cadastro de contas
      • Cadastrar uma conta PJ
      • Cadastrar uma conta PF
    • Informações da base de dados
      • Listar tipos de bloqueio
      • Listar escolaridades
      • Listar ocupações
    • BNPL
      • Consultar informações do portador
  • Portuno
    • Conta
      • Listar conta
      • Criar uma conta
      • Trocar o segredo da conta
    • Integração
      • Listar integrações
      • Alterar tempo de expiração de uma integração
  • Produtos
    • Produtos
      • Consultar produtos
      • Consultar um produto
    • Serviços financeiros
      • Listar serviços financeiros
  • Recompensa
    • Aderir à anuidade bonificada
    • Cancelar anuidade bonificada
    • Listar anuidades do produto
    • Listar anuidade do portador
    • Listar anuidades
    • Listar as anuidades
    • Cadastrar anuidades
  • Regulatório
    • Listar informações
  • Seguros
    • Seguros
      • Cancelar adesão do titular
      • Aderir seguro para o titular
      • Aderir seguro para dependente
      • Cancelar adesão do dependente
      • Listar seguros de dependentes
      • Listar seguros disponíveis
      • Cancelar um seguro
      • Listar seguros do portador
      • Listar campos de adesão ao seguro
      • Listar campos de adesão do portador
      • Listar seguros cancelados
    • Bilhetes de Seguro
      • Listar bilhetes de um portador
      • Listar o modelo de operação
      • Listar um bilhete de adesão
    • Cobranças e Pagamentos
      • Fazer estímulo de cobrança
    • Termos da Adesão
      • Listar termos de adesão
      • Listar modelos do código de operação
      • Listar termos de um seguro
  • Serviços Bancários
    • Registrar um boleto online
      POST
    • Listar pagamentos
      GET
    • Listar boleto completo
      GET
    • Listar contas habilitadas
      GET
  • SMS Notice
    • Processamento
      • Listar os eventos
      • Criar um evento
      • Alterar um evento
      • Listar as variáveis
      • Criar variáveis
      • Listar as transações
      • Criar mensagem para fila
    • Serviços
      • Criar um serviço de SMS
      • Listar serviços cadastrados
      • Alterar um serviço de SMS
      • Listar um serviço específico
    • Pacote de SMS
      • Listar os pacotes de sms
      • Cadastrar pacote SMS
      • Listar um pacote específico
      • Alterar um pacote específico
      • Aderir a um pacote SMS
      • Cancelar uma adesão
      • Listar adesões de um portador
      • Alterar o telefone do pacote
  1. Serviços Bancários

Registrar um boleto online

Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
POST
https://horizon-api-sb.app.rpe.tech
/api/v1/servicos-bancarios/fatura/{idFatura}/boletos
Use este endpoint para registrar um boleto online.
Serviço exclusivo para processadora Cards.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/servicos-bancarios/fatura//boletos?idContaBancaria' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
200 - Example 1
{
    "nomeSacado": "Luke Skywalker",
    "tipoInscricaoSacado": "9",
    "numeroInscricaoSacado": "99999999999",
    "enderecoSacado": {
        "logradouro": "Rua Paraguai",
        "complemento": "AP 999",
        "numero": "9999",
        "bairro": "Cristo Redentor",
        "cep": "58070598",
        "uf": "PB",
        "cidade": "João Pessoa"
    },
    "localPagamento": "Pagável preferencialmente nas lojas Varejista 12345 ou na Rede Bancária.",
    "numeroTitulo": "9999999",
    "nossoNumero": "0000099999999",
    "nossoNumeroDV": "9",
    "dataVencimento": "2012-11-07T01:00:00.000-02:00",
    "dataEmissao": "2012-10-07T09:43:26.450-03:00",
    "dataLimiteDesconto": "2012-11-05T10:43:26.450-02:00",
    "valorTitulo": 99.99,
    "valorPorDiaAtraso": 0,
    "valorDesconto": 0,
    "valorIOF": 0,
    "valorAbatimento": 0,
    "multaAtraso": 0,
    "valorDescontoDiario": 0,
    "valorMinimoTitulo": 120.33,
    "taxaJuros": 7,
    "taxaMulta": 2,
    "mensagemBoleto": "MENSAGEM DO BOLETO",
    "linhaDigitavelFormatada": "03399923313180000019721134101019300000000000000",
    "linhaDigitavel": "03399923313180000019721134101019300000000000000",
    "codigoBarras": "03393000000000000009923331800000192113410101",
    "especieTitulo": "99",
    "especieContaBancaria": "especieContaBancaria",
    "aceite": "N",
    "exibirDataVencimento": false,
    "mostrarValorBoleto": false,
    "cedente": {
        "nome": "Varejista 12345",
        "tipoInscricao": "9",
        "numeroInscricao": "99.999.999/0009-99",
        "agencia": "9999",
        "agenciaDV": "9",
        "conta": "99999999",
        "contaDV": "9",
        "posto": "campoPosto",
        "carteira": "999",
        "complementoCarteira": "complementoCarteira",
        "codigoContrato": "999-9",
        "codigoCedente": "9999999",
        "seqArquivo": "1234",
        "codigoBanco": "999-9",
        "tipoBanco": "P",
        "enderecoCedente": {
            "logradouro": "R. Antônio Régis de Brito",
            "complemento": "Complemento",
            "numero": "999",
            "bairro": "Pedro Gondim",
            "cep": "58031106",
            "uf": "PB",
            "cidade": "João Pessoa"
        }
    }
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
Parâmetros Path
idFatura
string 
requerido
Identificador da fatura.
Padrão:
2001
Exemplo:
2001
Parâmetros Query
idContaBancaria
integer <int64>
requerido
Identificador da conta bancária.
Padrão:
2001
Exemplo:
2001
Parâmetros Header
Authorization
string 
opcional
Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer
Exemplo:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ
Content-Type
string 
opcional
Tipo de mídia do corpo da solicitação.
Exemplo:
application/json
Accept
string 
opcional
Tipo do conteúdo aceito.
Exemplo:
application/json

Respostas

🟢200OK
application/json
OK
Body
nomeSacado
string 
opcional
Nome do portador sacado.
Exemplo:
Luke Skywalker
tipoInscricaoSacado
string 
opcional
Tipo de inscrição do sacado.
Exemplo:
9
numeroInscricaoSacado
string 
opcional
Número da inscrição do sacado.
Exemplo:
99999999999
enderecoSacado
object 
opcional
Informações sobre o endereço do sacado.
logradouro
string 
opcional
Logradouro.
Exemplo:
Rua Paraguai
complemento
string  | null 
opcional
Complemento.
Exemplo:
AP 999
numero
string 
opcional
Número.
Exemplo:
9999
bairro
string 
opcional
Bairro.
Exemplo:
Cristo Redentor
cep
string 
opcional
CEP.
Exemplo:
58070598
uf
string 
opcional
Unidade ferederativa ou estado.
Exemplo:
PB
cidade
string 
opcional
Cidade.
Exemplo:
João Pessoa
localPagamento
string 
opcional
Local para observações sobre o pagamento.
Exemplo:
Pagável preferencialmente nas lojas Varejista 12345 ou na Rede Bancária.
numeroTitulo
string 
opcional
Número do título.
Exemplo:
9999999
nossoNumero
string 
opcional
Nosso número.
Exemplo:
0000099999999
nossoNumeroDV
string 
opcional
Nosso Número do PDV.
Exemplo:
9
dataVencimento
string <date-time>
opcional
Data de vencimento.
Exemplo:
2012-11-07T01:00:00.000-02:00
dataEmissao
string <date-time>
opcional
Data de emissão.
Exemplo:
2012-10-07T09:43:26.450-03:00
dataLimiteDesconto
string <date-time>
opcional
Data limite para que o desconto seja aplicado.
Exemplo:
2012-11-05T10:43:26.450-02:00
valorTitulo
number <double>
opcional
Valor do título.
Exemplo:
99.99
valorPorDiaAtraso
number <double>
opcional
Valor cobrado a cada dia em atraso.
Exemplo:
0
valorDesconto
number <double>
opcional
Valor do desconto.
Exemplo:
0
valorIOF
number <double>
opcional
Valor do IOF.
Exemplo:
0
valorAbatimento
number <double>
opcional
Valor de abatimento.
Exemplo:
0
multaAtraso
number <double>
opcional
Multa cobrada por atraso do pagamento.
Exemplo:
0
valorDescontoDiario
number <double>
opcional
Valor do desconto diário.
Exemplo:
0
valorMinimoTitulo
number <double>
opcional
Valor mínimo do título.
Exemplo:
120.33
taxaJuros
integer 
opcional
Taxa de juros.
Exemplo:
7
taxaMulta
integer 
opcional
Taxa da multa.
Exemplo:
2
mensagemBoleto
string 
opcional
Mensagem do boleto.
Exemplo:
MENSAGEM DO BOLETO
linhaDigitavelFormatada
string 
opcional
Linha digitável formatada.
Exemplo:
03399923313180000019721134101019300000000000000
linhaDigitavel
string 
opcional
Linha digitável.
Exemplo:
03399923313180000019721134101019300000000000000
codigoBarras
string 
opcional
Código de barras.
Exemplo:
03393000000000000009923331800000192113410101
especieTitulo
string 
opcional
Código da espécie do título.
Exemplo:
99
especieContaBancaria
string 
opcional
Espécie da conta bancária.
Exemplo:
especieContaBancaria
aceite
string 
opcional
Aceite.
Exemplo:
N
exibirDataVencimento
boolean 
opcional
Indica se a data de vencimento deve ser exibida.
Exemplo:
false
mostrarValorBoleto
boolean 
opcional
Indica se o valor do boleto deve ser mostrado.
Exemplo:
false
cedente
object 
opcional
Informações sobre o cedente.
nome
string 
opcional
Nome do cedente.
Exemplo:
Varejista 12345
tipoInscricao
string 
opcional
Tipo de inscrição.
Exemplo:
9
numeroInscricao
string 
opcional
Número da inscrição estadual ou CNPJ.
Exemplo:
99.999.999/0009-99
agencia
string 
opcional
Agência do cedente.
Exemplo:
9999
agenciaDV
string 
opcional
Digito da agência do cedente.
Exemplo:
9
conta
string 
opcional
Conta do cedente.
Exemplo:
99999999
contaDV
string 
opcional
Digito da conta.
Exemplo:
9
posto
string  | null 
opcional
Posto.
Exemplo:
campoPosto
carteira
string 
opcional
Carteira.
Exemplo:
999
complementoCarteira
string  | null 
opcional
Complemento da carteira.
Exemplo:
complementoCarteira
codigoContrato
string 
opcional
Código do contrato.
Exemplo:
999-9
codigoCedente
string 
opcional
Código do cedente.
Exemplo:
9999999
seqArquivo
string  | null 
opcional
Sequência do arquivo.
Exemplo:
1234
codigoBanco
string 
opcional
Código do banco.
Exemplo:
999-9
tipoBanco
opcional
Tipo do banco.
CÓDIGO DO BANCONOME DO BANCO
PPADRAO
UUNIPRIME
CCNAB240
NCNAB400
SSICOOB
Valores permitidos:
PUCNS
Exemplo:
S
enderecoCedente
object 
opcional
Informações sobre o endereço do cedente.
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Serviços Bancários
Próxima página
Listar pagamentos