Listar contas pelo CPF (completo)

Use esse endpoint para visualizar todas as informações dos clientes cadastrados em um CPF.

Serviço exclusivo para processadora Cards.

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/portadores/completo/cpf?cpf' \ --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'

[ { "nome": "CLIENTE PADRAO HORIZON PAY I", "nomeSocial": "QA HORIZON PAY I", "email": "qatest@hpay.com", "dataNascimento": "2003-12-09", "nomeMae": "NOME MAE TEST", "rg": "166259189", "dataEmissaoRG": "2013-08-15", "cartaoTruncado": "6087XXXXXXXX5501", "profissao": { "idProfissao": 2, "descricao": "ADVOGADO" }, "enderecoResidencial": { "logradouro": "RUA HORIZON PAY", "complemento": "AP 500", "numero": "322", "bairro": "CENTRO", "cep": "58778970", "uf": "PB", "cidade": "JOAO PESSOA" }, "faturaFechada": { "id": 90869980, "dataVencimento": "2024-10-01", "valorTotal": 250, "somaPagamentos": 35, "valorMinimoRenegociacao": 100, "valorMinimoRotativo": 25, "valorPagamentoMinimo": 25, "valorPrestacoesParceladas": 15, "possuiPagamentoMinimo": true, "hashFatura": "ec6d2e71971de828a677d4c7d942ab8123745e438f9260842881182bc5c6d27c" }, "faturaFutura": { "dataVencimento": "2024-11-01", "valorTotal": 250 }, "idConta": 2001 }, { "nome": "CLIENTE PADRAO HORIZON PAY II", "nomeSocial": "QA HORIZON PAY I", "email": "qatest@hpay.com", "dataNascimento": "2003-12-09", "nomeMae": "NOME MAE TEST", "rg": "166259289", "dataEmissaoRG": "2013-08-15", "cartaoTruncado": "6087XXXXXXXX5543", "profissao": { "idProfissao": 2, "descricao": "ADVOGADO" }, "enderecoResidencial": { "logradouro": "RUA HORIZON PAY", "complemento": "AP 500", "numero": "322", "bairro": "CENTRO", "cep": "58778970", "uf": "PB", "cidade": "JOAO PESSOA" }, "faturaFechada": { "id": 90869981, "dataVencimento": "2024-10-01", "valorTotal": 250, "somaPagamentos": 35, "valorMinimoRenegociacao": 100, "valorMinimoRotativo": 25, "valorPagamentoMinimo": 25, "valorPrestacoesParceladas": 15, "possuiPagamentoMinimo": true, "hashFatura": "31a6e6d29af4a7555e82488ba0fc5100468fab562ec4b4f6596906f56eacbbf1" }, "faturaFutura": { "dataVencimento": "2024-11-01", "valorTotal": 75 }, "idConta": 2002 }, { "nome": "CLIENTE PADRAO HORIZON PAY III", "nomeSocial": "QA HORIZON PAY I", "email": "qatest@hpay.com", "dataNascimento": "2003-12-09", "nomeMae": "NOME MAE TEST", "rg": "166259398", "dataEmissaoRG": "2013-08-15", "cartaoTruncado": "6087XXXXXXXX6012", "profissao": { "idProfissao": 2, "descricao": "ADVOGADO" }, "enderecoResidencial": { "logradouro": "RUA HORIZON PAY", "complemento": "AP 500", "numero": "322", "bairro": "CENTRO", "cep": "58778970", "uf": "PB", "cidade": "JOAO PESSOA" }, "faturaFechada": { "id": 90870193, "dataVencimento": "2024-11-01", "valorTotal": 250, "somaPagamentos": 35, "valorMinimoRenegociacao": 100, "valorMinimoRotativo": 25, "valorPagamentoMinimo": 25, "valorPrestacoesParceladas": 15, "possuiPagamentoMinimo": true, "hashFatura": "8f57c2bd55a4f91e8eef5bfdbeb2bfdb34232f93d3a114069702024ba9b0c78e" }, "faturaFutura": { "dataVencimento": "2024-12-01", "valorTotal": 250 }, "idConta": 2003 } ]

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

cpf

string

requerido

CPF do portador.

Padrão:

94489708629

Exemplo:

94489708629

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

string

opcional

Tipo do conteúdo aceito.

Exemplo:

application/json

Respostas

🟢200OK

application/json

Body

array of:

nome

string

requerido

Nome completo do cliente.

Exemplo:

CLIENTE PADRAO HORIZON PAY

nomeSocial

string

opcional

Nome social do cliente.

Exemplo:

QA HPAY

string

opcional

Email do cliente.

Exemplo:

qatest@hpay.com

dataNascimento

string

requerido

Data de nascimento do portador.

Exemplo:

1996-08-12

nomeMae

string

requerido

Nome da mãe do portador do CPF.

Exemplo:

NOME MAE TEST

string

requerido

Número do RG do portador, com 9 dígitos e sem pontuação.

>= 9 Caracteres<= 9 Caracteres

Exemplo:

829655250

dataEmissaoRG

string

requerido

Data de emissão do RG.

Exemplo:

2007-02-10

cartaoTruncado

string

opcional

Número do cartão mascarado.

Exemplo:

6087XXXXXXXX5501

profissao

object

opcional

Dados da profissão do portador.

idProfissao

integer

opcional

Identificador da profissão do cliente.

Exemplo:

descricao

string

opcional

Descrição da profissão do cliente.

Exemplo:

ADMINISTRADOR DE EMPRESAS

enderecoResidencial

object

opcional

Dados do endereço do cliente.

logradouro

string

requerido

Logradouro do cliente.

Exemplo:

RUA HORIZON PAY

complemento

string

opcional

Complemento do endereço do cliente.

Exemplo:

AP 500

numero

string

requerido

Número do endereço do cliente.

Exemplo:

bairro

string

requerido

Bairro do cliente.

Exemplo:

BAIRRO HORIZON PAY

cep

string

requerido

Código de endereçamento postal (CEP) do cliente.

Exemplo:

58310000

string

requerido

Unidade federativa do cliente.

Exemplo:

cidade

string

requerido

Cidade do cliente.

Exemplo:

JOAO PESSOA

faturaFechada

object

opcional

Dados da fatura do cliente.

integer

opcional

Identificador da fatura.

Exemplo:

90870286

dataVencimento

string

opcional

Data de vencimento da fatura.

Exemplo:

2024-11-14

valorTotal

integer

opcional

Valor total da fatura fechada.

Exemplo:

250

somaPagamentos

integer

opcional

Soma dos pagamentos.

Exemplo:

valorMinimoRenegociacao

integer

opcional

Valor mínimo de renegociação.

Exemplo:

100

valorMinimoRotativo

integer

opcional

Valor mínimo rotativo.

Exemplo:

valorPagamentoMinimo

integer

opcional

Valor pagamento mínimo.

Exemplo:

valorPrestacoesParceladas

integer

opcional

Valor das prestações parceladas.

Exemplo:

possuiPagamentoMinimo

boolean

opcional

Indica se possui pagamento mínimo.

hashFatura

string

opcional

Hash da fatura.

Exemplo:

f68d0b4c7271b3391ef556a5s4c37397bcc6ac19de1a96bfb461cede65cc4c10f4

faturaFutura

object

opcional

Informações da próxima fatura futura do portador.

dataVencimento

string

opcional

Data de vencimento da próxima fatura.

Exemplo:

2024-12-14

valorTotal

integer

opcional

Valor total da próxima fatura.

Exemplo:

220

idConta

integer

opcional

Identificador da conta.

Exemplo:

2001

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor