Listar informações do portador

Use este endpoint para obter as informações de um portador a partir do seu identificador.

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

{ "nome": "NOME PORTADOR", "nomeSocial": "NOME SOCIAL", "cpf": "99999999999", "email": "email@email.com.br", "valorFatura": 241.3, "dataVencimentoFatura": "2024-01-10T03:00:00.000+0000", "diaCorte": 0, "diaVencimento": 10, "melhorDiaCompra": 1, "limitePrincipal": 75000, "limiteParcelado": 0, "saldoReservado": 0, "valorLancamentosFuturos": 9026.8, "numeroCartaoTruncado": " 0000XXXXXXXX0000", "idCartao": 99999, "statusCartao": "B", "numeroCartaoCriptografado": "qrdqzDjBrjaKw1ivttnOlgwtHza9R6Cf9/U00T8KBpE=", "limiteSaque": 0, "saldoDisponivelSaque": 0, "saldoDisponivelParcelado": 0, "saldoDisponivel": 65973.2, "dataCadastro": "2021-08-23", "portadorNecessidadesVisuais": false, "senhaExpirada": true, "statusFaturaDigital": "A", "dataFechamentoProxFatura": "2024-01-31", "permiteAcessoApp": true, "idOcupacao": 3, "idLojaCadastro": 1 }

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.

Padrão:

2001

Exemplo:

2001

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

opcional

One of

Processadora Cards

Processadora Dock

nome

string

opcional

O nome da pessoa portadora do cartão.

Exemplo:

NOME PORTADOR

nomeSocial

string

opcional

Nome social da pessoa portadora do cartão.

Exemplo:

NOME SOCIAL

cpf

string

opcional

Número do CPF da pessoa portadora do cartão, com 11 dígitos e sem pontuação.

Exemplo:

99999999999

string

opcional

O e-mail da pessoa portadora do cartão.

Exemplo:

email@email.com.br

valorFatura

number

opcional

O valor da fatura atual.

Exemplo:

241.3

dataVencimentoFatura

string <date-time>

opcional

A data de vencimento da fatura.

Exemplo:

2024-01-10T03:00:00.000+0000

diaCorte

integer <int32>

opcional

O dia de corte da fatura.

Exemplo:

diaVencimento

integer <int32>

opcional

O dia de vencimento da fatura.

Exemplo:

melhorDiaCompra

integer <int32>

opcional

O melhor dia para compra.

Exemplo:

limitePrincipal

number

opcional

O limite principal.

Exemplo:

75000

limiteParcelado

number

opcional

O limite parcelado.

Exemplo:

saldoReservado

number

opcional

Valor de saldo reservado.

Exemplo:

valorLancamentosFuturos

number

opcional

Valor dos lançamentos futuros.

Exemplo:

9026.8

numeroCartaoTruncado

string

opcional

O número truncado do cartão.

Exemplo:

0000XXXXXXXX0000

idCartao

integer <int64>

opcional

O identificador do cartão.

Exemplo:

99999

statusCartao

enum<string>

opcional

O status do cartão.

STATUS	SIGNIFICADO
A	Ativo
B	Bloqueado
C	Cancelado

Valores permitidos:

ABC

Exemplo:

numeroCartaoCriptografado

string

opcional

O número criptografado do cartão.

Exemplo:

qrdqzDjBrjaKw1ivttnOlgwtHza9R6Cf9/U00T8KBpE=

limiteSaque

number

opcional

O limite de saque.

Exemplo:

saldoDisponivelSaque

number

opcional

O saldo disponível para saque.

Exemplo:

saldoDisponivelParcelado

number

opcional

O saldo disponível parcelado.

Exemplo:

saldoDisponivel

number

opcional

O saldo disponível.

Exemplo:

65973.2

dataCadastro

string <date>

opcional

A data de cadastro, no formato YYYY-MM-DD.

Exemplo:

2021-08-23

portadorNecessidadesVisuais

boolean

opcional

Indica se a pessoa portadora do cartão possui necessidades visuais.

Padrão:

false

senhaExpirada

boolean

opcional

Indica se a senha do cartão está expirada.

Padrão:

true

statusFaturaDigital

enum<string>

opcional

Status da fatura digital.

STATUS	SIGNIFICADO
N	Não aderiu
P	Adesão pendente
A	Adesão ativa
C	Adesão cancelada

Valores permitidos:

NPAC

Exemplo:

dataFechamentoProxFatura

string <date>

opcional

A data de fechamento da próxima fatura.

Exemplo:

2024-01-31

permiteAcessoApp

boolean

opcional

Indica se permite acesso ao app.

Padrão:

true

idOcupacao

integer

opcional

Identificador da ocupação da pessoa portadora do cartão.

Exemplo:

idLojaCadastro

integer

opcional

Identificador da loja de cadastro.

Exemplo:

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor