Tote
InícioComece aquiAnalisaIntegra
InícioComece aquiAnalisaIntegra
  1. Gestão de portadores
  • Visão geral
  • O QUE HÁ DE NOVO
    • Release Notes
      • Horizon
  • GUIAS
    • Manuais
      • Diretrizes Básicas
      • Como se autenticar
      • Respostas e status
      • Nossas APIs
      • Webhook
      • FAQ
  • ESPECIFICAÇÕES
    • APIs
      • Autenticação
        • Gerar token de acesso
      • 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
        • Simulação
          • Criar simulação
        • Pré-autorização
          • Listar pré-autorização
          • 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 Pessoal
          • Cadastrar clientes para empréstimo
          • Solicitar crédito para 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
        • Empréstimo Simplificado
          • Listar bancos
          • Consultar informações de contrato
          • Consultar contratos de empréstimo
      • 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
        • 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
            GET
          • Listar portadores
            GET
          • Alterar dados do portador
            PATCH
          • Alterar status de ativo problemático
            PATCH
          • Listar informações do portador
            GET
          • Alterar o limite do portador
            PATCH
          • Bloquear um portador
            POST
          • Desbloquear um portador
            POST
          • Listar adicionais pelo CPF
            GET
          • Listar portadores em lote
            GET
          • Listar contas pelo CPF (simplificado)
            GET
          • Listar contas pelo CNPJ
            GET
          • Alterar produto do portador
            PATCH
          • Listar contas pelo documento
            GET
          • Listar contas pelo RG
            GET
          • Listar contas pelo nome
            GET
          • Alterar vipagem
            POST
          • Consultar ciclo do portador
            GET
          • Listar contas pelo CPF (completo)
            GET
        • 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
      • Regulatório
        • Listar informações
      • Recompensa
        • Aderir à anuidade bonificada
        • Cancelar anuidade bonificada
        • Listar anuidades do produto
        • Listar anuidade do portador
        • Listar anuidades
        • Listar as anuidades
        • Cadastrar anuidades
      • Serviços Bancários
        • Registrar um boleto online
        • Listar pagamentos
        • Listar boleto completo
        • Listar contas habilitadas
      • 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
      • 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. Gestão de portadores

Listar portadores

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/portadores/{idPortador}
Use este endpoint para visualizar os portadores do seu cartão cadastrados na sua base de dados.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/portadores/' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Response Response Example
200 - Cards
{
    "id": 2003,
    "nome": "MARIO SILVA OLIVEIRA BARROS",
    "nomeSocial": "MARIA SILVA OLIVEIRA BARROS",
    "nomeMae": "Maria",
    "estadoCivil": "CASADO",
    "sexo": "FEMININO",
    "rg": "768728788",
    "cpf": "32404963058",
    "cartao": "0000XXXXXXXX4488",
    "email": "[email protected]",
    "numeroCartaoTruncado": "509005XXXXXX4367",
    "clienteDataNascimento": "1970-01-01",
    "rendas": [
        {
            "id": 44,
            "valor": 788,
            "comprovada": "S",
            "idPessoa": 2001,
            "principal": "principal",
            "origem": "origem"
        }
    ],
    "statusCliente": "A",
    "statusAnalise": "A",
    "contratoImpresso": "S",
    "estanoCobranca": "N",
    "ultimoMotivoBloqueioCliente": "Bloqueio Teste",
    "extratoClienteResponse": {
        "limite": 2000.66,
        "saldoDisponivel": 2000.66,
        "saldoReservado": 1000.3,
        "saldoParceladoDisp": 1000.3,
        "limiteParcelado": 1000.3,
        "devedorTotal": 600.88,
        "utilizaLimiteExtra": false,
        "valorLimiteExtra": 120.33,
        "limiteExtraTotal": 120.33,
        "saldoDisponivelExtra": 120.33,
        "valorFaturaFechada": 1560.6,
        "clienteEmBloqueioJuridico": false
    },
    "valorLancamentosFuturos": 564.3,
    "pontuacaoFidelidadeResponse": {
        "idCliente": 2001,
        "valorPontuacao": 133,
        "dataReferencia": "2024-01-01",
        "descricaoPrograma": "descricaoPrograma"
    },
    "statusFaturaDigital": "A",
    "boletos": [
        {
            "id": 1260,
            "quantidadesRegistros": 123,
            "ordemRegistro": 123,
            "codigoBoleto": 6350,
            "valorTotal": 689.9,
            "valorJuros": 12.5,
            "valorPagamentosEfetuados": 155.6
        }
    ],
    "faturaFechada": {
        "id": 71365768,
        "dataVencimento": "2022-11-25",
        "valorTotal": 1350.2,
        "somaPagamentos": 170.56,
        "valorMinimoRenegociacao": 120.33,
        "valorMinimoRotativo": 300.3,
        "valorPagamentoMinimo": 450.98,
        "valorPrestacoesParceladas": 356.5,
        "possuiPagamentoMinimo": true,
        "hashFatura": "b9a16c4f64ebd04d04e66fa58d37a33c4ed8d506c84b89d83624c9ee66d23f00"
    },
    "faturaFutura": {
        "dataVencimento": "2022-12-25",
        "valorTotal": 1050.25
    },
    "statusCartao": "A",
    "melhorDiaCompra": 11,
    "senhaExpirada": true,
    "ciclo": {
        "id": 25,
        "diaCorte": 10,
        "diaVencimento": 2,
        "descricao": "VENCIMENTO 2",
        "ativo": "S",
        "corteUltimoDiaMes": "N",
        "diasCarencia": 0,
        "descricaoContaBancariaCicloAtual": "Banco do Brasil",
        "descricaoContaBancariaProximoCiclo": "Banco do Brasil"
    },
    "dependentes": [
        {
            "id": 124068,
            "nome": "FILHO DA CONTA NUMERO 2003",
            "nomeSocial": "MARIO OLIVEIRA BARROS",
            "cpf": "57465556066",
            "sexo": "M",
            "nascimento": "1991-11-28",
            "grauParentesco": 6,
            "statusCartao": "V"
        }
    ],
    "dataFechamentoProxFatura": "2023-01-10",
    "produto": {
        "id": 19,
        "descricao": "PRODUTO PADRAO 19",
        "isProdutoDigital": "S",
        "isProdutoBandeirado": "S",
        "encargos": {
            "cobrarMulta": true,
            "multa": 150.5,
            "regraCalculoMulta": "T",
            "ignorarMultaAnterior": true,
            "ignorarSaldoRolado": true,
            "mora": 13.5,
            "regraCalculoMora": "S",
            "jurosRotativo": 12.5,
            "realizarEstornoJurosPagamento": true
        },
        "limiteExtra": {
            "percentualPadrao": 15.3,
            "valorPadrao": 20.4,
            "habilitarClientesNovos": true
        },
        "overlimit": {
            "percentualSobreUso": 5.32,
            "permitePercentualSobreUso": true,
            "taxaSobreUso": 5.32,
            "permiteTaxaSobreUso": true,
            "permiteRepetirMesmoCiclo": true
        }
    },
    "dataCadastro": "2012-12-19",
    "taxas": [
        {
            "descricao": "TARIFA SEGUNDA VIA CARTAO",
            "valorContratado": 10.36,
            "desconto": 5.36,
            "dataFimDesconto": "2023-09-12",
            "dataFimDoCarencia": "2018-09-04",
            "numeroCobrancas": 1,
            "natureza": "T"
        },
        {
            "descricao": "TARIFA SEGUNDA VIA CARTAO",
            "valorContratado": 10.36,
            "desconto": 5.36,
            "dataFimDesconto": "2023-09-12",
            "dataFimDoCarencia": "2018-09-04",
            "numeroCobrancas": 0,
            "natureza": "T"
        }
    ],
    "estaEmPerda": false,
    "numeroCartaoCriptografado": "EiASLRIDRO/u6uCD3bm5cwwtHza9R6Cf9/U00T8KBpE=",
    "idCartao": 1805011,
    "permiteAcessoApp": true,
    "dataEmissaoRG": "2012-12-19",
    "estaEmAtraso": false,
    "orgaoEmissorRG": "SSP PB",
    "totalTentativasValidacaoCartao": 0,
    "enderecoResidencial": {
        "logradouro": "Rua residencial",
        "complemento": "Complemento residencial",
        "numero": "44",
        "bairro": "Bairro residencial",
        "cep": "58000000",
        "uf": "PB",
        "cidade": "JOAO PESSOA"
    },
    "inibirEnvioFaturaGrafica": false,
    "enderecoComercial": {
        "logradouro": "Rua dos comerciários",
        "complemento": "Complemento dos comerciários",
        "numero": "123",
        "bairro": "Bairro dos comerciários",
        "cep": "58071180",
        "uf": "PB",
        "cidade": "Cidade dos comerciários",
        "empresa": "Empresa",
        "departamento": "Departamento",
        "cnpj": "22130511000160"
    },
    "enderecoAlternativo": {
        "logradouro": "Rua dos alternativos",
        "complemento": "Complemento dos alternativos",
        "numero": "1322",
        "bairro": "Bairro dos alternativos",
        "cep": "58085460",
        "uf": "PB",
        "cidade": "Cidade dos alternativos",
        "tipo": "1"
    },
    "transicaoBandeira": "C",
    "utilizaOverLimitPersonalizado": false,
    "diasAtrasoTotal": 0,
    "diasProvisionamento": 1,
    "produtoTransicaoBandeira": {
        "id": 1,
        "descricao": "string",
        "isProdutoDigital": "string",
        "encargos": {
            "cobrarMulta": true,
            "multa": 12.6,
            "regraCalculoMulta": "T",
            "ignorarMultaAnterior": true,
            "ignorarSaldoRolado": true,
            "mora": 7.9,
            "regraCalculoMora": "S",
            "jurosRotativo": 6.3,
            "realizarEstornoJurosPagamento": true
        }
    }
}

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
idPortador
integer <int64>
requerido
Identificador do portador.
Em caso de testes com a processadora Cards, utilize o valor 2003. Para testes com a processadora Dock, utilize o valor 2001.
Exemplo:
20012003
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
opcional
One of
Response para listar as informações do portador através da processadora Cards.
id
integer <int64>
opcional
Identificador do portador.
Exemplo:
2003
nome
string 
opcional
Nome da pessoa portadora.
Exemplo:
MARIO SILVA OLIVEIRA BARROS
nomeMae
string 
opcional
Nome da mãe da pessoa portadora.
Exemplo:
Maria
estadoCivil
opcional
Estado civil da pessoa portadora.
Valores permitidos:
SOLTEIROCASADOVIUVODIVORCIADOOUTROAMASIADOUNIAO_ESTAVEL
Exemplo:
CASADO
sexo
opcional
Sexo da pessoa portadora.
Valores permitidos:
FEMININOMASCULINO
Exemplo:
FEMININO
nomeSocial
string 
opcional
Nome social da pessoa portadora.
Exemplo:
MARIA SILVA OLIVEIRA BARROS
rg
string 
opcional
Número do RG da pessoa portadora, sem pontuação.
>= 7 Caracteres<= 9 Caracteres
Exemplo:
7687287
cpf
string 
opcional
CPF da pessoa portadora, com 11 dígitos e sem pontuação.
Exemplo:
32404963058
cartao
string 
opcional
Número do cartão do portador, com mascaramento.
Exemplo:
0000XXXXXXXX4488
email
string 
opcional
E-mail do portador.
Exemplo:
[email protected]
numeroCartaoTruncado
string 
opcional
Número truncado do cartão.
Exemplo:
509005XXXXXX4367
clienteDataNascimento
string 
opcional
Data de nascimento do portador, no formato YYYY-MM-DD.
Exemplo:
1970-01-01
rendas
array [object {6}] 
opcional
Informação sobre a renda do portador.
statusCliente
enum<string> 
opcional
Status do cliente, onde A é ativo e B é bloqueado.
Valores permitidos:
AB
Exemplo:
A
statusAnalise
enum<string> 
opcional
O status da análise.
STATUSSIGNIFICADO
AAprovado
PAdesão pendente
RReprovado
Valores permitidos:
APR
Exemplo:
A
contratoImpresso
enum<string> 
opcional
Indica se o contrato foi impresso.
Valores permitidos:
SN
Exemplo:
S
estanoCobranca
enum<string> 
opcional
Indica se está em cobrança.
Valores permitidos:
SN
Exemplo:
N
ultimoMotivoBloqueioCliente
string 
opcional
Descrição do último movito de bloqueio do cliente.
Exemplo:
Bloqueio Teste
extratoClienteResponse
object 
opcional
Informações sobre o extrato do cliente.
valorLancamentosFuturos
number 
opcional
O valor dos lançamentos futuros.
Exemplo:
564.3
pontuacaoFidelidadeResponse
object 
opcional
Informações sobre o programa de fidelidade.
statusFaturaDigital
enum<string> 
opcional
Status da fatura digital.
STATUSSIGNIFICADO
NNão aderiu
PAdesão pendente
AAdesão ativa
CAdesão cancelada
Valores permitidos:
NPAC
Exemplo:
A
boletos
array [object {7}] 
opcional
Informações sobre boletos.
faturaFechada
object 
opcional
Informações sobre as faturas fechadas.
faturaFutura
object 
opcional
Informações sobre a fatura futura.
statusCartao
enum<string>  | enum<null> 
opcional
Status do cartão. Se titular possuir produto bandeira, esse campo retorna null.
STATUSSIGNIFICADO
AAtivo
BBloqueado
CCancelado
Valores permitidos:
VITBnull
Exemplo:
V
melhorDiaCompra
integer <int32>
opcional
Melhor dia de compra.
Exemplo:
11
senhaExpirada
boolean 
opcional
Indica se a senha do cartão expirou.
Padrão:
true
ciclo
object 
opcional
Informações sobre o ciclo da fatura.
dependentes
array [object {8}] 
opcional
dataFechamentoProxFatura
string <date>
opcional
Data de fechamento da próxima fatura, no formato YYYY-MM-DD.
Exemplo:
2023-01-10
produto
object 
opcional
Informações sobre o produto do portador.
dataCadastro
string <date>
opcional
Data de cadastro, no formato YYYY-MM-DD.
Exemplo:
2012-12-09
taxas
array [object {7}] 
opcional
estaEmPerda
boolean 
opcional
Indica se está em perda.
Exemplo:
false
numeroCartaoCriptografado
string 
opcional
Número criptografado do cartão
Exemplo:
EiASLRIDRO/u6uCD3bm5cwwtHza9R6Cf9/U00T8KBpE=
idCartao
integer <int64>
opcional
Identificador do cartão.
Exemplo:
1805011
permiteAcessoApp
boolean 
opcional
Indica se permite acesso ao app.
Exemplo:
true
dataEmissaoRG
string <date>
opcional
Data de emissão do RG, no formato YYYY-MM-DD.
Exemplo:
2012-12-19
estaEmAtraso
boolean 
opcional
Indica se está em atraso.
Exemplo:
false
orgaoEmissorRG
string 
opcional
Órgão emissor do RG.
Exemplo:
SSP PB
totalTentativasValidacaoCartao
integer <int32>
opcional
Total de tentativas para validação do cartão.
Exemplo:
0
enderecoResidencial
object 
opcional
inibirEnvioFaturaGrafica
boolean 
opcional
Indica se a fatura do portador irá para a gráfica.
Exemplo:
false
enderecoComercial
object 
opcional
enderecoAlternativo
object 
opcional
transicaoBandeira
enum<string> 
opcional
Transição da bandeira.
ValorSignificado
TEm transição
ITransição inativa
CTransição concluída
Valores permitidos:
TIC
Exemplo:
C
utilizaOverLimitPersonalizado
boolean 
opcional
Indica se utiliza o overlimit personalizado.
Exemplo:
false
diasAtrasoTotal
integer <int64>
opcional
Total de dias em atraso.
Exemplo:
0
diasProvisionamento
integer <int64>
opcional
Dias de provisionamento.
Exemplo:
1
produtoTransicaoBandeira
object 
opcional
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Listar status do portador pelo CPF
Próxima página
Alterar dados do portador