Tote
HomeAPIsGuiasRelease Notes
HomeAPIsGuiasRelease Notes
Fale conosco
  1. BNPL
  • 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
        PUT
      • Estornar venda
        POST
      • Simular venda
        POST
      • Confirmar venda
        PUT
      • Sensibilizar venda
        POST
  • 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
    • Listar pagamentos
    • Listar boleto completo
    • Listar contas habilitadas
  • 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. BNPL

Simular venda

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/acheron/bnpl/transacao/pdv/simulador
BNPL
Use este endpoint para simular vendas no PDV através do BNPL.
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/acheron/bnpl/transacao/pdv/simulador' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "cnpjEmissor": "99999999999999",
    "cpfCnpjConsumidor": "99999999999",
    "valor": 50.1,
    "quantidadeParcelas": 1,
    "idProduto": 1,
    "diasCarencia": 0
}'
Response Response Example
200 - Example 1
[
    {
        "contrato": {
            "tipo": "VENDA",
            "codigoBarra": "1746541201925",
            "cnpjEmissor": "04561957001644",
            "estabelecimento": "YPIRA",
            "cpfCnpjConsumidor": "45120460000191",
            "nomeConsumidor": "Consumidor PJ",
            "valor": 24.84,
            "valorTaxaOperacao": 1,
            "valorTotal": 25.84,
            "quantidadeDeParcelas": 1,
            "adicionalFinanceiro": 0.2484,
            "bloqueado": false,
            "elegivelVendor": false,
            "cdcAptosRemessaList": [],
            "valorTotalParcelas": 0,
            "cetTotal": 2,
            "cetMensal": 1.6262,
            "cetAnual": 21.68,
            "taxaJurosParcela": 1,
            "diasCarencia": 0
        },
        "planoPagamento": {
            "scoreConsumidor": "A",
            "quantidadeDiasPrimeiraParcela": 30,
            "tipoTaxaOperacao": "PRIMEIRA_PARCELA",
            "valorTaxaOperacao": 1,
            "valorTaxaRepasse": 1,
            "descricaoProduto": "CDC",
            "carencia": true,
            "limiteMaximoDiasCarencia": 10,
            "taxaDeJurosMensal": 1
        },
        "cdcList": [
            {
                "numeroParcela": 1,
                "totalParcelas": 1,
                "dataEmissao": "2025-05-06T10:59:58-0300",
                "dataVencimento": "2025-06-05",
                "valor": 25.25,
                "valorTaxaOperacao": 1,
                "multa": 0,
                "mora": 0,
                "iofDiarioAtraso": 0,
                "iofAdicionalAtraso": 0,
                "tpAmortizacaoIOF": 0.16,
                "tpAmortizacaoPrincipal": 24.84,
                "tpJurosIOF": 0,
                "tpJurosPrincipal": 0.25,
                "valorTotal": 26.25,
                "ajusteCredito": 0,
                "ajusteDebito": 0
            }
        ]
    },
    {
        "contrato": {
            "tipo": "VENDA",
            "codigoBarra": "1746541201290",
            "cnpjEmissor": "04561957001644",
            "estabelecimento": "YPIRA",
            "cpfCnpjConsumidor": "45120460000191",
            "nomeConsumidor": "Consumidor PJ",
            "valor": 24.84,
            "valorTaxaOperacao": 0,
            "valorTotal": 24.84,
            "quantidadeDeParcelas": 1,
            "adicionalFinanceiro": 0.0822,
            "bloqueado": false,
            "elegivelVendor": false,
            "cdcAptosRemessaList": [],
            "valorTotalParcelas": 0,
            "cetTotal": 1,
            "cetMensal": 1.4622,
            "cetAnual": 19.32,
            "taxaJurosParcela": 1,
            "diasCarencia": 0
        },
        "planoPagamento": {
            "scoreConsumidor": "A",
            "quantidadeDiasPrimeiraParcela": 10,
            "tipoTaxaOperacao": "ISENTO",
            "valorTaxaOperacao": 1,
            "valorTaxaRepasse": 10,
            "descricaoProduto": "CDC",
            "carencia": false,
            "limiteMaximoDiasCarencia": 0,
            "taxaDeJurosMensal": 1
        },
        "cdcList": [
            {
                "numeroParcela": 1,
                "totalParcelas": 1,
                "dataEmissao": "2025-05-06T10:59:58-0300",
                "dataVencimento": "2025-05-16",
                "valor": 25.04,
                "valorTaxaOperacao": 0,
                "multa": 0,
                "mora": 0,
                "iofDiarioAtraso": 0,
                "iofAdicionalAtraso": 0,
                "tpAmortizacaoIOF": 0.12,
                "tpAmortizacaoPrincipal": 24.84,
                "tpJurosIOF": 0,
                "tpJurosPrincipal": 0.08,
                "valorTotal": 25.04,
                "ajusteCredito": 0,
                "ajusteDebito": 0
            }
        ]
    },
    {
        "contrato": {
            "tipo": "VENDA",
            "codigoBarra": "1746541203642",
            "cnpjEmissor": "04561957001644",
            "estabelecimento": "YPIRA",
            "cpfCnpjConsumidor": "45120460000191",
            "nomeConsumidor": "Consumidor PJ",
            "valor": 24.84,
            "valorTaxaOperacao": 4.9,
            "valorTotal": 29.74,
            "quantidadeDeParcelas": 1,
            "adicionalFinanceiro": 0,
            "bloqueado": false,
            "elegivelVendor": false,
            "cdcAptosRemessaList": [],
            "valorTotalParcelas": 0,
            "cetTotal": 1,
            "cetMensal": 0.634,
            "cetAnual": 7.99,
            "taxaJurosParcela": 0,
            "diasCarencia": 0
        },
        "planoPagamento": {
            "scoreConsumidor": "A",
            "quantidadeDiasPrimeiraParcela": 31,
            "tipoTaxaOperacao": "REPLICAR_EM_TODAS_AS_PARCELAS",
            "valorTaxaOperacao": 4.9,
            "valorTaxaRepasse": 0,
            "descricaoProduto": "CDC",
            "carencia": false,
            "limiteMaximoDiasCarencia": 0,
            "taxaDeJurosMensal": 0
        },
        "cdcList": [
            {
                "numeroParcela": 1,
                "totalParcelas": 1,
                "dataEmissao": "2025-05-06T10:59:58-0300",
                "dataVencimento": "2025-06-06",
                "valor": 25,
                "valorTaxaOperacao": 4.9,
                "multa": 0,
                "mora": 0,
                "iofDiarioAtraso": 0,
                "iofAdicionalAtraso": 0,
                "tpAmortizacaoIOF": 0.16,
                "tpAmortizacaoPrincipal": 24.84,
                "tpJurosIOF": 0,
                "tpJurosPrincipal": 0,
                "valorTotal": 29.9,
                "ajusteCredito": 0,
                "ajusteDebito": 0
            }
        ]
    },
    {
        "contrato": {
            "tipo": "VENDA",
            "codigoBarra": "1746541203791",
            "cnpjEmissor": "04561957001644",
            "estabelecimento": "YPIRA",
            "cpfCnpjConsumidor": "45120460000191",
            "nomeConsumidor": "Consumidor PJ",
            "valor": 24.84,
            "valorTaxaOperacao": 3,
            "valorTotal": 27.84,
            "quantidadeDeParcelas": 1,
            "adicionalFinanceiro": 1.7895,
            "bloqueado": false,
            "elegivelVendor": false,
            "cdcAptosRemessaList": [],
            "valorTotalParcelas": 0,
            "cetTotal": 8,
            "cetMensal": 7.8259,
            "cetAnual": 150.11,
            "taxaJurosParcela": 7.2,
            "diasCarencia": 0
        },
        "planoPagamento": {
            "scoreConsumidor": "A",
            "quantidadeDiasPrimeiraParcela": 30,
            "tipoTaxaOperacao": "REPLICAR_EM_TODAS_AS_PARCELAS",
            "valorTaxaOperacao": 3,
            "valorTaxaRepasse": 0,
            "descricaoProduto": "CDC",
            "carencia": false,
            "limiteMaximoDiasCarencia": 0,
            "taxaDeJurosMensal": 7.2
        },
        "cdcList": [
            {
                "numeroParcela": 1,
                "totalParcelas": 1,
                "dataEmissao": "2025-05-06T10:59:58-0300",
                "dataVencimento": "2025-06-05",
                "valor": 26.8,
                "valorTaxaOperacao": 3,
                "multa": 0,
                "mora": 0,
                "iofDiarioAtraso": 0,
                "iofAdicionalAtraso": 0,
                "tpAmortizacaoIOF": 0.16,
                "tpAmortizacaoPrincipal": 24.84,
                "tpJurosIOF": 0.01,
                "tpJurosPrincipal": 1.79,
                "valorTotal": 29.8,
                "ajusteCredito": 0,
                "ajusteDebito": 0
            }
        ]
    }
]

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
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
Parâmetros Bodyapplication/json
cnpjEmissor
string 
requerido
CNPJ do emissor, com 14 dígitos e sem pontuação.
Exemplo:
99999999999999
cpfCnpjConsumidor
string 
requerido
CPF ou CNPJ do cliente, sem pontuação.
Exemplo:
9999999999999999999999999
valor
number <float>
requerido
Valor da compra.
>= 1<= 10
Exemplo:
50.1
quantidadeParcelas
integer <int32>
opcional
Quantidade de parcelas.
>= 1
Exemplo:
1
idProduto
integer <int64>
opcional
Identificador do produto.
Exemplo:
1
diasCarencia
integer <int32>
opcional
Dias de carência para a venda.
Exemplo:
0
Examples

Respostas

🟢200Success
application/json
Body
array of:
contrato
object 
opcional
tipo
enum<string> 
opcional
Tipo do contrato.
Valores permitidos:
VENDARENEGOCIADOACORDO
Exemplo:
VENDA
codigoBarra
string 
opcional
Código de barras da transação.
Exemplo:
1734618600102
cnpjEmissor
string 
opcional
CNPJ do emissor, com 14 dígitos e sem pontuação.
Exemplo:
13550170000191
estabelecimento
string 
opcional
Estabelecimento da transação.
Exemplo:
Estabelecimento ABC
cpfCnpjConsumidor
string 
opcional
CPF ou CNPJ do cliente, sem pontuação.
Exemplo:
04266674252
nomeConsumidor
string 
opcional
Nome do cliente, seja pessoa física ou pessoa jurídica.
Exemplo:
Maria José Silva
valor
number 
opcional
Valor do contrato.
Exemplo:
100
valorTaxaOperacao
number 
opcional
Valor da taxa de operação.
Exemplo:
6
valorTotal
number 
opcional
Valor total do contrato.
Exemplo:
106
quantidadeDeParcelas
integer <int32>
opcional
Quantidade de parcelas.
Exemplo:
2
adicionalFinanceiro
number 
opcional
Adicional financeiro do contrato.
Exemplo:
0
bloqueado
boolean 
opcional
Indica se o contrato está bloqueado.
Exemplo:
false
elegivelVendor
boolean 
opcional
Indica se o contrato é elegível a ser considerado Vendor.
Exemplo:
false
cdcAptosRemessaList
array[string]
opcional
Informações sobre lista de CDCs aptos a serem Vendor.
valorTotalParcelas
number 
opcional
Valor total das parcelas.
Exemplo:
100
cetTotal
number 
opcional
Valor total do custo efetivo total.
Exemplo:
120
cetMensal
number 
opcional
Valor mensal do custo efetivo total.
Exemplo:
10
cetAnual
number 
opcional
Valor anual do custo efetivo total.
Exemplo:
120
taxaJurosParcela
number 
opcional
Taxa de juros da parcela.
Exemplo:
0
diasCarencia
integer <int32>
opcional
Dias de carência.
Exemplo:
5
planoPagamento
object 
opcional
Informações sobre plano de pagamento.
scoreConsumidor
enum<string> 
opcional
Valor de score do consumidor, determinado pelos motores de crédito.
Valores permitidos:
ABCDEFNAO_INFORMADO
Exemplo:
A
quantidadeDiasPrimeiraParcela
integer <int32>
opcional
Quantidade de dias até a primeira parcela.
Exemplo:
15
tipoTaxaOperacao
enum<string> 
opcional
Tipo da taxa de operação.
Valores permitidos:
PRIMEIRA_PARCELAREPLICAR_EM_TODAS_AS_PARCELASISENTO
Exemplo:
ISENTO
valorTaxaOperacao
number 
opcional
Valor da taxa de operação.
Exemplo:
3
valorTaxaRepasse
number 
opcional
Valor da taxa de repasse.
Exemplo:
0
descricaoProduto
string 
opcional
Descrição do produto.
Exemplo:
CDC.
carencia
boolean 
opcional
Indica se há carência.
Exemplo:
false
limiteMaximoDiasCarencia
integer <int32>
opcional
Limite máximo para os dias de carência.
Exemplo:
1
taxaDeJurosMensal
integer <int32>
opcional
Taxa de juros mensal da operação.
Exemplo:
0
cdcList
array [object {17}] 
opcional
numeroParcela
integer <int32>
opcional
Número de parcelas.
Exemplo:
1
totalParcelas
integer <int32>
opcional
Total de parcelas do CDC.
Exemplo:
2
dataEmissao
string <date-time>
opcional
Data de emissão do CDC.
Exemplo:
2024-12-19T11:21:43-0300
dataVencimento
string <date-time>
opcional
Data de vencimento do CDC, no formato YYYY-MM-DD.
Exemplo:
2025-01-19
valor
number 
opcional
Valor do CDC.
Exemplo:
100
valorTaxaOperacao
number 
opcional
Valor da taxa de operação do CDC.
Exemplo:
3
multa
number 
opcional
Valor da multa do CDC.
Exemplo:
0
mora
number 
opcional
Valor do juros de mora do CDC.
Exemplo:
0
iofDiarioAtraso
number 
opcional
Valor de IOF diário por atraso do CDC.
Exemplo:
0
iofAdicionalAtraso
number 
opcional
Valor de IOF adicional por atraso.
Exemplo:
0
tpAmortizacaoIOF
number 
opcional
Tabela Price de amortização do IOF.
Exemplo:
0
tpAmortizacaoPrincipal
number 
opcional
Tabela Price de amortização principal.
Exemplo:
100
tpJurosIOF
number 
opcional
Tabela Price do juros IOF.
Exemplo:
0
tpJurosPrincipal
number 
opcional
Tabela Price do juros principal.
Exemplo:
0
valorTotal
number 
opcional
Valor total do CDC.
Exemplo:
103
ajusteCredito
number 
opcional
Valor de ajuste de crédito.
Exemplo:
0
ajusteDebito
integer 
opcional
Valor de ajuste de débito.
Exemplo:
0
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
🟠400Pedido inválido
Página anterior
Estornar venda
Próxima página
Confirmar venda