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
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
Parâmetros Path
idPortador
integer <int64>
requerido
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
BearerExemplo:
Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ
Content-Type
string
opcional
Exemplo:
application/json
Accept
string
opcional
Exemplo:
application/json