Tote
HomeAPIsGuiasRelease Notes
HomeAPIsGuiasRelease Notes
Fale conosco
  1. Empréstimo FGTS
  • 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
        POST
      • Obter saldo
        POST
      • Cadastrar pessoa física
        POST
      • Cadastrar operação
        POST
      • Submeter para aprovação
        POST
      • Consultar informações
        GET
      • Listar produto
        GET
      • Consultar pessoa
        GET
      • Listar operações
        GET
      • Acompanhar operação
        GET
      • Listar estado civil
        GET
      • Listar bancos
        GET
  • 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. Empréstimo FGTS

Acompanhar operação

Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
GET
https://horizon-api-sb.app.rpe.tech
/api/v1/emprestimos/fgts/operacao/{idOperacao}
Emprestimo FGTS
Utilize este endpoint para acompanhar operações.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/emprestimos/fgts/operacao/' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
200 - Example 1
{
    "creditNoteNo": 2288,
    "productId": "21e30554-a0c0-496c-b848-4a8fefab2291",
    "productIdDisplay": "CCB FGTS",
    "fundId": "string",
    "fundIdDisplay": "string",
    "acceptanceDate": "string",
    "amortization": {
        "amortizationType": "fgts",
        "calculateByValueType": "Gross",
        "requestedAmount": 1946824,
        "principalAmountInCents": 1946824,
        "startDate": "2022-09-27T09:00:00-03:00",
        "termInMonths": 3,
        "absAmortizationInMonths": 0,
        "absInterestInMonths": 0,
        "apr": 0.02,
        "periodicity": "Monthly",
        "daysInYear": 0,
        "agentCommission": {
            "amount": 0.06,
            "type": "1",
            "baseValue": "0"
        },
        "bankCommission": {
            "amount": 0.06,
            "type": "1",
            "baseValue": "0"
        },
        "financeOperationsTax": 0.0038,
        "dailyFinanceOperationsTax": 0.000082,
        "indexer": "string",
        "indexerValue": 0,
        "paymentDay": 0,
        "administrationFeeIncents": 0,
        "realStatevalue": 0,
        "physicalDamageInsurance": 0,
        "deathOrPermanentIncapabilityInsurance": 0,
        "skippedMonths": "string",
        "monthlyInterest": 0.02,
        "yearlyInterest": 0.2682417945625455,
        "effectiveMonthlyCost": 0.02238183892552348,
        "effectiveYearlyCost": 0.3042399999999992,
        "liquidValue": 1903790,
        "comm": 0,
        "finTax": 43113,
        "dueDate": "2024-11-01T09:00:00-03:00",
        "initialValue": 1946822,
        "fixedPaymentDuringGraduation": 0,
        "termsUntilGraduation": 0,
        "absAfterGraduation": 0,
        "pmt2Value": 0,
        "fiduciaryGuarantee": 0,
        "financeTaxExempted": false,
        "issueNumber": 0,
        "quantity": 0,
        "unitPrice": 0
    },
    "personId": "3db0feba-974b-4a46-8f61-39650adafceb",
    "personDisplay": "Liz Teresinha Assunção",
    "personDiscriminator": "NaturalPerson",
    "beneficiaryId": "3db0feba-974b-4a46-8f61-39650adafceb",
    "beneficiaryDisplay": "Liz Teresinha Assunção",
    "beneficiaryDiscriminator": "NaturalPerson",
    "liquidationType": "EletronicTransfer",
    "invoiceBarCode": "string",
    "observations": "Este é um primeiro teste de inserção de operação de empréstimo FGTS",
    "collateral": "string",
    "invoiceValue": 100000,
    "invoiceNumber": "00000000010000000000000000000000000000000000000000",
    "changeBankAccountId": "29b90d4c-5e2a-4f29-9214-4b0a8deabce9",
    "changeBankAccount": {
        "bankCode": "Banco_do_Brasil_SA",
        "bankCodeCompe": 1,
        "bankCodeDisplay": "Banco do Brasil S.A.",
        "account": "20968",
        "accountDigit": "0",
        "agency": "1619",
        "agencyDigit": "0",
        "type": "NaturalSimpleAccount",
        "typeDisplay": "Conta Simples de Pessoa Física",
        "jointAccount": false,
        "id": "29b90d4c-5e2a-4f29-9214-4b0a8deabce5",
        "createdAt": "2022-09-22T13:37:04.989717-03:00",
        "createdBy": {
            "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
            "userIdDisplay": "André Luís",
            "tenantDisplay": "UY3 STG"
        },
        "updatedAt": "2022-09-22T13:37:04.989717-03:00",
        "updatedBy": {
            "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
            "userIdDisplay": "André Luís",
            "tenantDisplay": "UY3 STG"
        }
    },
    "status": "Revision",
    "statusDisplay": "Revisão",
    "bankAccount": {
        "bankCode": "Banco_do_Brasil_SA",
        "bankCodeCompe": 1,
        "bankCodeDisplay": "Banco do Brasil S.A.",
        "account": "20968",
        "accountDigit": "0",
        "agency": "1619",
        "agencyDigit": "0",
        "type": "NaturalSimpleAccount",
        "typeDisplay": "Conta Simples de Pessoa Física",
        "jointAccount": false,
        "id": "29b91d4c-5e2a-4f29-9214-4b0a8deabce4",
        "createdAt": "2022-09-22T13:37:04.989717-03:00",
        "createdBy": {
            "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
            "userIdDisplay": "André Luís",
            "tenantDisplay": "UY3 STG"
        },
        "updatedAt": "2022-09-22T13:37:04.989717-03:00",
        "updatedBy": {
            "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
            "userIdDisplay": "André Luís",
            "tenantDisplay": "UY3 STG"
        }
    },
    "bankAccountId": "29b92d4c-5e2a-4f29-9214-4b0a8deabce3",
    "tokenName": "string",
    "isRegistered": false,
    "bulkAssignment": false,
    "blockedUntil": "string",
    "timeline": [
        {
            "index": 0,
            "name": "Rascunho",
            "startedAt": "2022-09-26T12:29:57.303781-03:00",
            "finishedAt": "2022-09-26T12:29:57.303781-03:00",
            "description": "Registro criado",
            "id": "3441a81c-c5e3-4747-a53c-f4b44577f2ed",
            "createdAt": "2022-09-26T12:29:57.303781-03:00",
            "createdBy": {
                "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
                "userIdDisplay": "André Luís",
                "tenantDisplay": "UY3 STG"
            },
            "updatedAt": "2022-09-26T12:29:57.303781-03:00",
            "updatedBy": {
                "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
                "userIdDisplay": "André Luís",
                "tenantDisplay": "UY3 STG"
            }
        }
    ],
    "assets": [
        {
            "id": "string",
            "createdAt": "2022-09-26T12:29:57.303781-03:00",
            "createdBy": {
                "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
                "userIdDisplay": "André Luís",
                "tenantDisplay": "UY3 STG"
            },
            "updatedAt": "2022-09-26T12:29:57.303781-03:00",
            "updatedBy": {
                "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
                "userIdDisplay": "André Luís",
                "tenantDisplay": "UY3 STG"
            },
            "assetType": "string",
            "assetTypeDisplay": "string",
            "description": "string",
            "registerNumber": "string",
            "estimatedValue": 0,
            "settled": true
        }
    ],
    "relatedPersonCreditNote": [
        {
            "personId": "string",
            "discriminator": "string",
            "personIdDisplay": "string",
            "typeOfRelationship": "string",
            "typeOfRelationshipDisplay": "string",
            "relatedToId": "string",
            "relatedToDiscriminator": "string",
            "relatedToIdDisplay": "string"
        }
    ],
    "uploads": [
        {
            "id": "string",
            "createdAt": "2022-09-26T12:29:57.303781-03:00",
            "createdBy": {
                "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
                "userIdDisplay": "André Luís",
                "tenantDisplay": "UY3 STG"
            },
            "updatedAt": "2022-09-26T12:29:57.303781-03:00",
            "updatedBy": {
                "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
                "userIdDisplay": "André Luís",
                "tenantDisplay": "UY3 STG"
            },
            "fileName": "string",
            "fileType": "string",
            "displayName": "string",
            "tempUrl": "string",
            "tempGetUrl": "string",
            "tempPutUrl": "string"
        }
    ],
    "paymentScheduleItems": [
        {
            "id": "25727aeb-d5db-42f1-832a-e6b05966986d",
            "dueDate": "2022-09-27T09:00:00-03:00",
            "principalAmountInCents": 1946824,
            "amortization": 0,
            "interest": 0,
            "financeTax": 0,
            "payment": 0,
            "tokenName": "string",
            "tokenAmount": 0
        }
    ],
    "id": "e7abe0b9-a580-402c-8b25-86d6daf3ccc6",
    "createdAt": "2022-09-26T12:29:55.281348-03:00",
    "createdBy": {
        "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
        "userIdDisplay": "André Luís",
        "tenantDisplay": "UY3 STG"
    },
    "updatedAt": "2022-09-26T12:29:55.281348-03:00",
    "updatedBy": {
        "userId": "8e290133-51da-4036-b2a4-8af4c6db215c",
        "userIdDisplay": "André Luís",
        "tenantDisplay": "UY3 STG"
    }
}

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
idOperacao
string 
requerido
Identificador da operação.
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
default response
Body
Resposta do acompanhar operação.
creditNoteNo
integer <int32>
opcional
Número da nota de crédito.
Exemplo:
2288
productId
string 
opcional
Identificador do produto.
Exemplo:
21e30554-a0c0-496c-b848-4a8fefab2291
productIdDisplay
string 
opcional
Identificador exibível do produto.
Exemplo:
CCB FGTS
fundId
string 
opcional
Fundo da operação, caso não informado, será utilizado o padrão do produto, se houver
fundIdDisplay
string 
opcional
Nome de exibição do fundo da operação
acceptanceDate
string 
opcional
Data de aceite do contrato por parte do tomador
amortization
object (Amortization) 
opcional
Informações de amortização.
amortizationType
string 
opcional
Tipo da amortização.
Exemplo:
fgts
calculateByValueType
string 
opcional
Tipo de cálculo baseado no valor.
Exemplo:
Gross
requestedAmount
integer <int64>
opcional
Valor pedido.
Exemplo:
1946824
principalAmountInCents
integer <int32>
opcional
Valor principal, em centavos.
Exemplo:
1946824
startDate
string 
opcional
Data de início.
Exemplo:
2022-09-27T09:00:00-03:00
termInMonths
integer <int32>
opcional
Período de amortização em meses.
Exemplo:
3
absAmortizationInMonths
integer <int32>
opcional
Amortização em meses.
Exemplo:
0
absInterestInMonths
integer <int32>
opcional
Juros em meses.
Exemplo:
0
apr
number <double>
opcional
Taxa de porcentagem anual.
Exemplo:
0.02
periodicity
string 
opcional
Periodicidade.
Exemplo:
Monthly
daysInYear
integer <int32>
opcional
Dias no ano.
Exemplo:
0
agentCommission
object (AgentAndBankCommission) 
opcional
bankCommission
object (AgentAndBankCommission) 
opcional
financeOperationsTax
number <double>
opcional
Taxas de operação.
Exemplo:
0.0038
dailyFinanceOperationsTax
number <double>
opcional
Taxas de operação diária.
Exemplo:
0.000082
indexer
string 
opcional
Nome do indexador pós-fixado da operação, se utilizado
indexerValue
number <double>
opcional
Quantidade (em percentual) do indexador que será aplicada a cada parcela da operação
paymentDay
integer <int32>
opcional
Dia de pagamento.
Exemplo:
0
administrationFeeIncents
integer <int32>
opcional
Taxa de administração. Valor é aplicado em cada título. Usado apenas em operações de CCI/Home Equity
realStatevalue
integer <int32>
opcional
Valor do imóvel envolvido como garantia da operação. Utilizado apenas em operação de CCI/Home Equity
physicalDamageInsurance
number <double>
opcional
Valor de Seguro DFI. Valor é aplicado em cada título. Usado apenas em operações de CCI/Home Equity
deathOrPermanentIncapabilityInsurance
number <double>
opcional
Valor de Seguro MIP. Valor é aplicado em cada título. Usado apenas em operações de CCI/Home Equity
skippedMonths
string 
opcional
Meses do ano em que foi dada carência no pagamento da parcela. Usado apenas em operações de CCI/Home Equity
monthlyInterest
number <double>
opcional
Juros mensais.
Exemplo:
0.02
yearlyInterest
number <double>
opcional
Juros anuais.
Exemplo:
0.2682417945625455
effectiveMonthlyCost
number <double>
opcional
Custos efetivos mensais.
Exemplo:
0.02238183892552348
effectiveYearlyCost
number <double>
opcional
Custos efetivos anuais.
Exemplo:
0.3042399999999992
liquidValue
integer <int64>
opcional
Valor líquido.
Exemplo:
1903790
comm
integer <int32>
opcional
Exemplo:
0
finTax
integer <int32>
opcional
Exemplo:
43113
dueDate
string 
opcional
Data de vencimento.
Exemplo:
2024-11-01T09:00:00-03:00
initialValue
integer <int64>
opcional
Valor inicial.
Exemplo:
1946822
fixedPaymentDuringGraduation
integer <int32>
opcional
Valor da parcela durante o curso. Utilizado em operações de Financiamento Estudantil
termsUntilGraduation
integer <int32>
opcional
Número de períodos até o término do curso. Utilizado em operações de Financiamento Estudantil
absAfterGraduation
integer <int32>
opcional
Número de períodos com carência de pagamento após o término do curso. Utilizado em operações de Financiamento Estudantil
pmt2Value
number <double>
opcional
Valor do pagamento após o término da carência após conclusão do curso. Utilizado em operações de Financiamento Estudantil
fiduciaryGuarantee
number <double>
opcional
Percentual de garantia fiduciária da operação. Utilizada em operações com garantia de duplicata.
financeTaxExempted
boolean 
opcional
Valor de isenção de imposto.
Exemplo:
false
issueNumber
integer <int32>
opcional
Número de expedição.
Exemplo:
0
quantity
integer <int32>
opcional
Quantidade.
Exemplo:
0
unitPrice
integer <int32>
opcional
Preço unitário.
Exemplo:
0
personId
string 
opcional
Identificador da pessoa.
Exemplo:
3db0feba-974b-4a46-8f61-39650adafceb
personDisplay
string 
opcional
Informação exibível da pessoa.
Exemplo:
Liz Teresinha Assunção
personDiscriminator
string 
opcional
Discriminante.
Exemplo:
NaturalPerson
beneficiaryId
string 
opcional
Identificador do beneficiário.
Exemplo:
3db0feba-974b-4a46-8f61-39650adafceb
beneficiaryDisplay
string 
opcional
Informação exibível do beneficiário.
Exemplo:
Liz Teresinha Assunção
beneficiaryDiscriminator
string 
opcional
Discriminante do beneficiário.
Exemplo:
NaturalPerson
liquidationType
string 
opcional
Tipo da liquidação.
Exemplo:
EletronicTransfer
invoiceBarCode
string 
opcional
Linha digitável, para quando o tipo de liquidação é por boleto
observations
string 
opcional
Observações.
Exemplo:
Este é um primeiro teste de inserção de operação de empréstimo FGTS
collateral
string 
opcional
Dados da garantia da operação
invoiceValue
integer <int32>
opcional
Valor da nota.
Exemplo:
100000
invoiceNumber
string 
opcional
Número da nota.
Exemplo:
00000000010000000000000000000000000000000000000000
changeBankAccountId
string 
opcional
Identificador da conta bancária.
Exemplo:
29b90d4c-5e2a-4f29-9214-4b0a8deabce2
changeBankAccount
object (ChangeBankAccountAndBankAccount) 
opcional
bankCode
string 
opcional
Código do banco.
Exemplo:
Banco_do_Brasil_SA
bankCodeCompe
integer <int32>
opcional
Código bancário para compensação.
Exemplo:
1
bankCodeDisplay
string 
opcional
Código bancário exibido.
Exemplo:
Banco do Brasil S.A.
account
string 
opcional
Número da conta.
Exemplo:
20968
accountDigit
string 
opcional
Dígito da conta.
Exemplo:
0
agency
string 
opcional
Agência bancária.
Exemplo:
1619
agencyDigit
string 
opcional
Dígito da agência.
Exemplo:
0
type
string 
opcional
Tipo da conta.
Exemplo:
NaturalSimpleAccount
typeDisplay
string 
opcional
Tipo exibido.
Exemplo:
Conta Simples de Pessoa Física
jointAccount
boolean 
opcional
Indica se é conta conjunta.
Exemplo:
false
id
string 
opcional
Identificador da conta.
Exemplo:
29b90d4c-5e2e-4f29-9214-5b0a8deabce6
createdAt
string 
opcional
Data de criação.
Exemplo:
2022-09-22T13:37:04.989717-03:00
createdBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre a criação.
updatedAt
string 
opcional
Data de atualização.
Exemplo:
2022-09-22T13:37:04.989717-03:00
updatedBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre atualização.
status
string 
opcional
Status.
Exemplo:
Revision
statusDisplay
string 
opcional
Status exibível.
Exemplo:
Revisão
bankAccount
object (ChangeBankAccountAndBankAccount) 
opcional
Conta bancária.
bankAccountId
string 
opcional
Identificador da conta bancária.
Exemplo:
29b90d4c-5e2a-4f29-9214-4b0a8deabce1
tokenName
string 
opcional
Nome do token/NFT caso registrado em blockchain
isRegistered
boolean 
opcional
Indica se está registrado.
Exemplo:
false
bulkAssignment
boolean 
opcional
Indica se é uma atribuição em massa.
Exemplo:
false
blockedUntil
string 
opcional
Operação bloqueado até a data
timeline
array[object (TimeLine) {10}] 
opcional
Lista de eventos relevantes que ocorreram na operação de crédito.
index
integer <int32>
opcional
Indexador.
Exemplo:
0
name
string 
opcional
Nome.
Exemplo:
Rascunho
startedAt
string 
opcional
Data inicial.
Exemplo:
2022-09-26T12:29:57.303781-03:00
finishedAt
string 
opcional
Data final.
Exemplo:
2022-09-26T12:29:57.303781-03:00
description
string 
opcional
Descrição do evento.
Exemplo:
Registro criado
id
string 
opcional
Identificador.
Exemplo:
3441a81c-c5e3-4747-a53c-f4b44577f2ed
createdAt
string 
opcional
Data de criação.
Exemplo:
2022-09-26T12:29:57.303781-03:00
createdBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre criação.
updatedAt
string 
opcional
Data de atualização.
Exemplo:
2022-09-26T12:29:57.303781-03:00
updatedBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre atualização.
assets
array[object (Assets) {11}] 
opcional
Lista de IDs das garantias vinculadas à operação. Podem ser garantias da(s) PFs ou PJs vinculadas à operação.
id
string 
opcional
Identificador.
createdAt
string 
opcional
Data de criação.
Exemplo:
2022-09-26T12:29:57.303781-03:00
createdBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre criação.
updatedAt
string 
opcional
Data de atualização.
Exemplo:
2022-09-26T12:29:57.303781-03:00
updatedBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre atualização.
assetType
string 
opcional
Tipo do ativo.
assetTypeDisplay
string 
opcional
Tipo exibível do ativo.
description
string 
opcional
Descrição.
registerNumber
string 
opcional
Número do registro.
estimatedValue
number <double>
opcional
Valor estimado.
settled
boolean 
opcional
Indica se houve acordo.
relatedPersonCreditNote
array[object (RelatedPersonCreditNote) {8}] 
opcional
Lista das pessoas relacionadas a operação.
personId
string 
opcional
Identificador da pessoa.
discriminator
string 
opcional
Discriminante.
personIdDisplay
string 
opcional
Identificador exibível da pessoa.
typeOfRelationship
string 
opcional
Tipo de relação.
typeOfRelationshipDisplay
string 
opcional
Tipo exibível de relação.
relatedToId
string 
opcional
Relação descrita.
relatedToDiscriminator
string 
opcional
Relação descrita pelo discriminante.
relatedToIdDisplay
string 
opcional
Relação exibível.
uploads
array[object (Uploads) {11}] 
opcional
Lista de arquivos relacionadas a operação.
id
string 
opcional
Identificador.
createdAt
string 
opcional
Data de criação.
Exemplo:
2022-09-26T12:29:57.303781-03:00
createdBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre a criação.
updatedAt
string 
opcional
Data de atualização.
Exemplo:
2022-09-26T12:29:57.303781-03:00
updatedBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre a atualização.
fileName
string 
opcional
Nome do arquivo.
fileType
string 
opcional
Tipo do arquivo.
displayName
string 
opcional
Nome exibível.
tempUrl
string 
opcional
URL temporária.
tempGetUrl
string 
opcional
URL GET temporária.
tempPutUrl
string 
opcional
URL PUT temporária.
paymentScheduleItems
array[object (PaymentScheduleItems) {9}] 
opcional
Lista de parcelas relacionadas a operação.
id
string 
opcional
Identificador.
Exemplo:
25727aeb-d5db-42f1-832a-e6b05966986d
dueDate
string 
opcional
Data de vencimento.
Exemplo:
2022-09-27T09:00:00-03:00
principalAmountInCents
integer <int32>
opcional
Valor em centavos.
Exemplo:
1946824
amortization
integer <int32>
opcional
Amortização.
Exemplo:
0
interest
integer <int32>
opcional
Taxa de juros.
Exemplo:
0
financeTax
integer <int32>
opcional
Valor do imposto.
Exemplo:
0
payment
integer <int32>
opcional
Pagamento.
Exemplo:
0
tokenName
string 
opcional
Nome do token.
tokenAmount
number <double>
opcional
Valor do token.
id
string 
opcional
Identificador.
Exemplo:
e7abe0b9-a580-402c-8b25-86d6daf3ccc6
createdAt
string 
opcional
Data de criação.
Exemplo:
2022-09-26T12:29:55.281348-03:00
createdBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre a criação.
updatedAt
string 
opcional
Data de atualização.
Exemplo:
2022-09-26T12:29:55.281348-03:00
updatedBy
object (InfoCreatedByOrUpdateBy) 
opcional
Informações sobre atualizações.
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Listar operações
Próxima página
Listar estado civil