45 - Consultar Conta por Documento

Scopes:

api.ext api.conta.consultaPorDocumento

Endpoint responsável por consultar informações de uma conta bancária com base no documento de identificação do correntista.

cURL

curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/Conta/ConsultaContaPorDocumento \
  --header 'Authorization: <api-key>'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "dtConsulta": "2023-11-07T05:31:56Z",
  "documentoFederal": "<string>",
  "contas": [
    {
      "agencia": "<string>",
      "agenciaDigito": "<string>",
      "conta": "<string>",
      "contaDigito": "<string>",
      "contaPgto": "<string>",
      "parceiro": "<string>",
      "documentoFederal": "<string>",
      "valorBloqueado": 123
    }
  ]
}

Por meio deste endpoint, o parceiro pode consultar um determinado documento, obterá através do integrador, o retorno de todas as contas vinculadas ao documento consultado sob o domínio da integração.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/Conta/ConsultaContaPorDocumento	Documento inválido
/api/Conta/ConsultaContaPorDocumento	Operador não configurado para esta integração
/api/Conta/ConsultaContaPorDocumento	Correntista não cadastrado

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

DocumentoFederal · string

CPF ou CNPJ do correntista para consulta.*

Observações:

• O CPF ou CNPJ do correntista para consulta pode ter no máximo 14 caracteres.
• Informar apenas os números do documento sem os caracteres de formatação (exemplo: ponto, traço, barra, etc.).

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null

dtConsulta · string<date-time>

tipoPessoa · enum<integer>

Opções disponíveis: 1, 2

documentoFederal · string | null

contas · object[] | null

Show child attributes