PagueContas

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

Changed on

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. Também disponibiliza a possibilidade da criação de uma transação de desafio para validação do cartão por meio da confirmação de um valor aleatório.

Requisição

CampoTipoDescriçãoObrigatório
ConsultadoTipoTextoIndica se a consulta será através do CPF ou CNPJSim
ConsultadoCPFCNPJTextoCPF ou CNPJ consultadoSim
ConsultadoNomeTextoNome completo do consultado (sem abreviações)Não
ConsultadoDataNascimentoTextoData de nascimento do consultadoNão
ConsultadoEmailTextoE-mail do consultadoNão
ConsultadoNomeMaeTextoNome da mãe do consultadoNão
EmailVerificadoBoleanoInforma True ou false, para indicar se o e-mail consultado foi verificadoNão
SessaoIDTextoIdentificador da SessãoNão
DadosConsultadoEnderecoConsultaCartaoTitularEnderecoNão
CEPTextoCEP do ConsultadoNão (1)
EnderecoTextoLogradouro do ConsultadoNão (1)
NumeroTextoNúmero do endereço do ConsultadoNão (1)
ComplementoTextoComplemento do ConsultadoNão (1)
BairroTextoBairro do endereço do ConsultadoNão (1)
CidadeTextoCidade do endereço do ConsultadoNão (1)
UFTextoUF do endereço do ConsultadoNão (1)
PaisTextoPais do endereço do ConsultadoNão (1)
--------
DadosConsultadoTelefoneConsultaCartaoTitularTelefoneSim
DDINúmeroIndica o país do telefone do Consultado (Ex: 55)Sim
DDDNúmeroIndica o estado do telefone do Consultado (Ex: 41)Sim
NumeroNúmeroNúmero de telefone do ConsultadoSim
TelefoneVerificadoBoleanoInforma True ou false, para indicar se o número de telefone consultado foi verificadoNão
--------
DadosConsultadoCartaoConsultaCartaoTitularCartaoDadosSim
NomeImpresso (Obrigatório)TextoNome do titular do cartãoSim
NumeroCartao (Obrigatório)Numérico de 16 posiçõesNúmero do cartãoSim
DataValidadeAno/Mês no formato AAAAMMData de validade do cartãoNão(2)
CodigoSegurancaNumérico de 3 posiçõesCódigo de segurança no verso do cartãoNão(2)
TitularCPFCNPJTextoCPF/ CNPJ do titular do cartãoNão(2)
--------
ConsultadoTipoAdicionalTextoOpção complemento dos dados do consultado, podendo ser CPF ou CNPJNão
ConsultadoCPFCNPJAdicionalTextoCPF ou CNPJ do consultadoNão
TransacaoDataTextoData da transaçãoNão
TransacaoTipoTextoIndicar se a transação foi realizada Presencial ou OnlineNão
HabilitarDesafioBoleanoIndica se deve ser gerada uma transção com valor aleatório para validação do cartãoNão
<br />

(1) - Obrigatório se DadosConsultadoEndereco for informado (2) - Obrigatório se HabilitarDesafio = true

Resposta

CampoTipoDescrição
IDTextoID da consulta
ResultadoTextoResultado da consulta, sendo com ou sem restrição
ErroTituloTextoTítulo das ocorrências, em casos de erro
ErroInstanciaTextoEm qual parte do processo ocorreu o erro
ErroDetalheTextoDetalhes do erro
ErroTipoTextoTipo do erro
CardTokenTextoIdentificador do token gerado para o cartão
IdentificadorDesafioTextoIdentificador do desafio gerado
post/api/PagueContas/ConsultaCartaoTitular

Request

  • Base URL
    https://pagamentos.meuk8.com.br/PagamentosAPI
  • URL
    https://pagamentos.meuk8.com.br/PagamentosAPI/api/PagueContas/ConsultaCartaoTitular
  • Auth
    OAuth 2
    Password
    Token URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI

Headers

Aeskeystring required

Request body

HabilitarDesafioboolean
ConsultadoTipostring required
ConsultadoCPFCNPJstring required
ConsultadoNomestring
ConsultadoDataNascimentostring date-time
ConsultadoEmailstring
ConsultadoNomeMaestring
EmailVerificadoboolean
SessaoIdstring
ConsultadoTipoAdicionalstring
ConsultadoCPFCNPJAdicionalstring
TransacaoDatastring date-time
TransacaoTipo'Presencial' | 'Online'

Example request

{
  "HabilitarDesafio": false,
  "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": "27619720-41e4-42a3-a080-3e459a2f7182",
  "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": "203008",
    "CodigoSeguranca": "1234",
    "TitularCPFCNPJ": "48455151480"
  },
  "ConsultadoTipoAdicional": "CNPJ",
  "ConsultadoCPFCNPJAdicional": "72264224000111",
  "TransacaoData": "2026-08-19T10:15:28.7157399-03:00",
  "TransacaoTipo": "Presencial"
}

Response

Consulta Cartao Titular

CardTokenstring uuid
IdentificadorDesafiostring uuid
Idstring uuid
Resultadostring
ErroTititulostring
ErroInstanciastring
ErroDetalhestring
ErroTipostring

Example response

{
  "CardToken": "00000000-0000-0000-0000-000000000000",
  "IdentificadorDesafio": "00000000-0000-0000-0000-000000000000",
  "Id": "00000000-0000-0000-0000-000000000000"
}

Changes