Consultar CPF

Sandbox

https://horizon-api-sb.app.rpe.tech

GET

/api/v1/pixcard/consulta/{cpfPessoa}

Use este endpoint para consultar, usando o CPF, a condição da pessoa portadora para adesão à assinatura do serviço Pix Card.

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

Parâmetros Header

Respostas

🟢200OK

application/json

Body

🟠400Pedido inválido

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/pixcard/consulta/29414867989' \
--header 'Accept: */*' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json'

Response Example

200 - Example 1

{
    "idPessoa": 2973,
    "nomeEmissor": "flamboyan",
    "tennantUY3": "f09f6609-199a-494f-b5bf-9d57c0530ff8",
    "emissorCardsId": 2001,
    "produtoDockId": 0,
    "contaCardsId": 2001,
    "emissorHabilitarProdutoPixCard": true,
    "cpfPessoaPix": "29414867989",
    "pessoaUY3Id": "f09f6609-199a-494f-b5bf-9d57c0530ff8",
    "contaAceitaUY3": true,
    "contaDockId": 2001,
    "contaAceitaDock": true,
    "statusContaDock": "NAO_CRIADA",
    "chavePixCard": "true",
    "assinatura": {
        "idAssinatura": 2648,
        "dataContratacao": "2024-12-10",
        "idPlano": 4,
        "dataValidade": "2025-01-10",
        "statusAssinatura": "VENCIDA"
    },
    "limitePixCard": {
        "limiteTotal": 75000,
        "limiteDisponivel": 75000
    }
}