v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

ConsultaCartaoTitular

Analisa a titularidade de um cartão de crédito

O endpoint oferece uma avaliação da titularidade do cartão de crédito consultado. Dentro dos retornos desse módulo são apresentadas as informações da restrição para continuidade da operação. <br />

Requisição

Campo	Tipo	Descrição	Obrigatório
ConsultadoTipo	Texto	Indica se a consulta será através do CPF ou CNPJ	Sim
ConsultadoCPFCNPJ	Texto	CPF ou CNPJ consultado	Sim
ConsultadoNome	Texto	Nome completo do consultado (sem abreviações)	Não
ConsultadoDataNascimento	Texto	Data de nascimento do consultado	Não
ConsultadoEmail	Texto	E-mail do consultado	Não
ConsultadoNomeMae	Texto	Nome da mãe do consultado	Não
EmailVerificado	Booleano	Informa True ou false, para indicar se o e-mail consultado foi verificado	Não
SessaoID	GUID	Identificador da Sessão	Não
DadosConsultadoEndereco	ConsultaCartaoTitularEndereco	-
CEP	Texto	CEP do Consultado	Não
Endereco	Texto	Logradouro do Consultado	Não
Numero	Texto	Número do endereço do Consultado	Não
Complemento	Texto	Complemento do Consultado	Não
Bairro	Texto	Bairro do endereço do Consultado	Não
Cidade	Texto	Cidade do endereço do Consultado	Não
UF	Texto	UF do endereço do Consultado	Não
País	Texto	País do endereço do Consultado	Não
DadosConsultadoTelefone	ConsultaCartaoTitularTelefone	-
DDI	Número	Indica o país do telefone do Consultado (Ex: 55)	Sim
DDD	Número	Indica o estado do telefone do Consultado (Ex: 41)	Sim
Numero (Obrigatório)	Número	Número de telefone do Consultado	Sim
TelefoneVerificado	Booleano	Informa True ou false, para indicar se o número de telefone consultado foi verificado	Não
DadosConsultadoCartao	ConsultaCartaoTitularCartaoDados	-
NomeImpresso	Texto	Nome do titular do cartão	Sim
NumeroCartao	Numérico de 16 posições	Número do cartão	Sim
DataValidade	Ano/Mês no formato AAAAMM	Data de validade do cartão	Não
CodigoSeguranca	Numérico de 3 posições	Código de segurança no verso do cartão	Não
TitularCPFCNPJ	Texto	CPF/ CNPJ do titular do cartão	Não
ConsultadoTipoAdicional	Texto	Opção complemento dos dados do consultado, podendo ser CPF ou CNPJ	Não
ConsultadoCPFCNPJAdicional	Texto	CPF ou CNPJ do consultado	Não
TransacaoData	Texto	Data da transação	Não
TransacaoTipo	Texto	Indicar se a transação foi realizada Presencial ou Online	Não

<br />

Resposta

Campo	Tipo	Descrição
ID	Guid	ID da consulta
Resultado	Texto	Resultado da consulta, sendo com ou sem restrição
ErroTitulo	Texto	Título das ocorrências, em casos de erro
ErroInstancia	Texto	Em qual parte do processo ocorreu o erro
ErroDetalhe	Texto	Detalhes do erro
ErroTipo	Texto	Tipo do erro

post/api/ConsultaCartaoTitular

Headers

Aeskeystring required

Request body

ConsultadoTipostring required

ConsultadoCPFCNPJstring required

ConsultadoNomestring

ConsultadoDataNascimentostring date-time

ConsultadoEmailstring

ConsultadoNomeMaestring

EmailVerificadoboolean

SessaoIdstring

ConsultadoTipoAdicionalstring

ConsultadoCPFCNPJAdicionalstring

TransacaoDatastring date-time

TransacaoTipo'Presencial' | 'Online'

Example request

{
  "ConsultadoTipo": "CPF",
  "ConsultadoCPFCNPJ": "48455151480",
  "ConsultadoNome": "Renato Samuel Augusto Baptista",
  "ConsultadoDataNascimento": "1987-02-13T00:00:00",
  "ConsultadoEmail": "renatosamuel@umdominio.com.br",
  "ConsultadoNomeMae": "Renato Samuel Augusto Baptista",
  "EmailVerificado": false,
  "SessaoId": "058e7ffd-ed7e-4cac-b05a-0c9a7fa93e8b",
  "DadosConsultadoEndereco": {
    "CEP": "82510290",
    "Endereco": "Rua Canadá, 257",
    "Numero": "13",
    "Complemento": "Ap 16",
    "Bairro": "Bacacheri",
    "Cidade": "Curitiba",
    "UF": "PR",
    "Pais": "Brasil"
  },
  "DadosConsultadoTelefone": {
    "DDI": 55,
    "DDD": 41,
    "Numero": 999293802,
    "TelefoneVerificado": false
  },
  "DadosConsultadoCartao": {
    "NomeImpresso": "Renato Samuel Augusto Baptista",
    "NumeroCartao": "4024007105862618",
    "DataValidade": "203005",
    "CodigoSeguranca": "1234",
    "TitularCPFCNPJ": "48455151480"
  },
  "ConsultadoTipoAdicional": "CNPJ",
  "ConsultadoCPFCNPJAdicional": "72264224000111",
  "TransacaoData": "2026-05-21T09:47:50.9532973-03:00",
  "TransacaoTipo": "Presencial"
}

Response

ConsultaCartaoTitular

Idstring uuid

Resultadostring

ErroTititulostring

ErroInstanciastring

ErroDetalhestring

ErroTipostring

Example response

{
  "Id": "00000000-0000-0000-0000-000000000000"
}