40 - Account Consult by Document

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",
  "tipoPessoa": 1,
  "documentoFederal": "<string>",
  "contas": [
    {
      "agencia": "<string>",
      "agenciaDigito": "<string>",
      "conta": "<string>",
      "contaDigito": "<string>",
      "contaPgto": "<string>",
      "tipoConta": 1,
      "modeloConta": 1,
      "situacao": 1,
      "parceiro": "<string>",
      "documentoFederal": "<string>",
      "tipoBloqueio": 0,
      "valorBloqueado": 123
    }
  ]
}

Through this endpoint, the partner can consult a specific document and will receive, through the integrator, the return of all accounts linked to the consulted document under the integration domain.

Authorizations

Authorization · string · header · required

Copie 'Bearer ' + token

Query Parameters

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.).

Response

200

application/json

Success

sucesso · boolean

mensagem · string | null

dtConsulta · string<date-time>

tipoPessoa · enum<integer>

Available options: 1, 2

documentoFederal · string | null

contas · object[] | null

Show child attributes

contas. agencia · string | null

Número da agência bancária.*

Observações:

• O número da agência pode ter no máximo 4 caracteres.

contas. agenciaDigito · string | null

Dígito verificador da agência bancária.

Observações:

• O dígito verificador da agência bancária pode ter no máximo 1 caracter.

contas. conta · string | null

Número da conta bancária.

Observações:

• O número da conta bancária pode ter no máximo 12 caracteres.
• Para que seja possível localizar a conta, é necessário informar o 'número da conta com dígito' (contaPgto) ou o 'número da conta' (conta) e o 'dígito verificador' (contaDigito).
• Caso o 'número da conta com dígito' (contaPgto) seja informado, não é necessário preencher os campos 'número da conta' (conta) e 'dígito verificador' (contaDigito).
• Caso nenhum dos campos referentes ao número da conta seja informado, ocorrerá erro na requisição devido à falta de informação vital.

contas. contaDigito · string | null

Dígito verificador do número da conta bancária.

Observações:

• O dígito verificador do número da conta bancária pode ter no máximo 1 caracter.

contas. contaPgto · string | null

Número da conta bancária seguido do dígito verificador.

Observações:

• O número da conta seguido do dígito verificador pode ter no máximo 20 caracteres.

contas. tipoConta · enum<integer>

Tipo da conta.*

Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario

Available options: 1, 2, 3, 4

contas. modeloConta · enum<integer>

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Available options: 1, 2, 3

contas. situacao · enum<integer>

Situacao conta.*

Valores: 1 - Ativa 2 - Inativa 3 - Fechada 4 - Cadastrado

Available options: 1, 2, 3, 4

contas. parceiro · string | null

Nome do parceiro.

contas. documentoFederal · string | null

Documento federal do parceiro.

contas. tipoBloqueio · enum<integer>

Tipo bloqueio conta.

Valores: 0 - Sem Bloqueio 1 - Débito 2 - Crédito 3 - Débito e Crédito

Available options: 0, 1, 2, 3

contas. valorBloqueado · number<double> | null

Valor de bloqueio.