45 - Create Account

Scopes:

api.ext api.conta.criar

Endpoint responsável por criar uma nova conta corrente no sistema.

cURL

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/v2/Conta \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "numeroBanco": "<string>",
  "numeroAgencia": "<string>",
  "numeroConta": "<string>",
  "digitoConta": "<string>",
  "descricao": "<string>",
  "tipoGeracaoNumeroConta": 0,
  "modCobrTaxa": 0,
  "tipoConta": 123,
  "dadosCorrentista": {
    "documentoFederal": "<string>",
    "nome": "<string>",
    "tipoPessoa": 123,
    "situacao": 1
  },
  "dadosContato": {
    "email": "<string>",
    "telefoneFixo1": "<string>",
    "telefoneFixo2": "<string>",
    "telefoneCelular1": "<string>",
    "telefoneCelular2": "<string>",
    "telefoneFax": "<string>",
    "paginaWeb": "<string>"
  },
  "dadosEndereco": {
    "cep": "<string>",
    "logradouro": "<string>",
    "nroLogradouro": "<string>",
    "bairro": "<string>",
    "complemento": "<string>",
    "cidade": "<string>",
    "uf": "<string>",
    "tipoEndereco": 1,
    "tipoResidencia": 1,
    "enderecoDesde": "2023-11-07T05:31:56Z",
    "enderecoPrincipal": true,
    "enderecoCorrespondencia": true,
    "verificadoInLoco": true
  },
  "dadosPF": {
    "apelido": "<string>",
    "rg": "<string>",
    "rgOrgao": "<string>",
    "rguf": "<string>",
    "rgData": "2023-11-07T05:31:56Z",
    "dtNasc": "2023-11-07T05:31:56Z",
    "sexo": "<string>",
    "nacionalidade": "<string>",
    "naturalDeCidade": "<string>",
    "naturalDeUF": "<string>",
    "estadoCivil": 1,
    "escolaridade": 1,
    "nomePai": "<string>",
    "nomeMae": "<string>",
    "nomeConjuge": "<string>",
    "dtNascConjuge": "2023-11-07T05:31:56Z",
    "cpfConjuge": "<string>",
    "rgConjuge": "<string>",
    "rgOrgaoConjuge": "<string>",
    "rgufConjuge": "<string>",
    "rgDataConjuge": "2023-11-07T05:31:56Z",
    "nomeArquivoIdentificacao": "<string>",
    "arquivoIdentificacao": "<string>",
    "indicadorPEP": 1,
    "renda": 123,
    "profissao": "<string>"
  },
  "dadosPJ": {
    "nomeFantasia": "<string>",
    "documentoEstadual": "<string>",
    "documentoMunicipal": "<string>",
    "dtAberturaEmpresa": "2023-11-07T05:31:56Z",
    "nomeResponsavelEmpresa": "<string>",
    "cpfResponsavelEmpresa": "<string>",
    "rgResponsavelEmpresa": "<string>",
    "nomeArquivoContratoSocial": "<string>",
    "arquivoContratoSocial": "<string>",
    "capitalSocial": 123,
    "faturamentoAnual": 123,
    "tipoEmpresa": 1,
    "codigoCnae": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "modeloConta": 1
}
'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "numero": "<string>",
  "digito": "<string>",
  "contaPagamento": "<string>"
}

Through this endpoint, the partner can open an account under the integrator’s domain.

Authorizations

Authorization · string · header · required

Copie 'Bearer ' + token

Headers

IdempotencyKey · string · required

IgnoraHandshake · boolean · default: true · required

(somente em homologação)

Body

numeroBanco · string | null

Número do banco.*

Observação:

• O 'número do banco' (numeroBanco) pode ter no máximo 3 caracteres.

numeroAgencia · string | null

Número da agência.*

Observação:

• O número da agência pode ter no máximo 4 caracteres.
• Valor padrão: '0001'

numeroConta · string | null

Número da conta bancária.

Observações:

• O 'número da conta' (numeroConta) é obrigatório quando o 'tipo de geração' (tipoGeracaoNumeroConta) informado for 0 (manual).
• O 'número da conta' (numeroConta) não deve ser informado quando o 'tipo de geração' (tipoGeracaoNumeroConta) informado for 1 (sequencial).
• O número da conta bancária pode ter no máximo 12 caracteres.

digitoConta · string | null

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

Observação:

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

descricao · string | null

Informações adicionais sobre a conta.

tipoGeracaoNumeroConta · enum<integer>

Tipo de geração de conta.*

Observação:

• Valor padrão: '0'

Valores: 0 - Manual 1 - Sequencial

Available options: 0, 1

modCobrTaxa · enum<integer>

Modelo de cobrança de taxa.*

Observação:

• Valor padrão: '1'

Valores: 0 - Desativado 1 - Parceiro 1 - Cliente

Available options: 0, 1, 2

tipoConta · integer<int32>

Tipo de conta.*

Observação:

• Valor padrão: '3'

Valores: -1 - CACC 2 - SVGS 3 - TRAN 4 - SLRY

dadosCorrentista · object

Objeto detalhado da identificação do correntista vinculado à conta.*

Show child attributes

dadosCorrentista. documentoFederal · string | null

Número do CPF ou CNPJ do correntista.*

Observações:

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

dadosCorrentista. nome · string | null

Nome completo do correntista.*

Observação:

• O nome do correntista pode ter no máximo 100 caracteres.

dadosCorrentista. tipoPessoa · integer<int32>

Tipo de pessoa.

Valores: 1 - PF 2 - PJ

dadosCorrentista. situacao · enum<integer>

Situacao.

Valores: 1 - Ativado 2 - Desativado

Available options: 1, 2

dadosContato · object

Objeto detalhado do contato do correntista vinculado à conta.*

Show child attributes

dadosContato. email · string | null

Email de contato do correntista.*

Observação:

• O email de contato do correntista pode ter no máximo 60 caracteres.

dadosContato. telefoneFixo1 · string | null

Número do 1º telefone fixo do correntista.

Observações:

• Informar o código de área seguido do número do telefone. Exemplo: 11551234567 (representa o telefone número 11 55123-4567)
• O número do 1º telefone fixo do correntista pode ter no máximo 20 caracteres.

dadosContato. telefoneFixo2 · string | null

Número do 2º telefone fixo do correntista.

Observações:

• Informar o código de área seguido do número do telefone. Exemplo: 11551234567 (representa o telefone número 11 55123-4567)
• O número do 2º telefone fixo do correntista pode ter no máximo 20 caracteres.

dadosContato. telefoneCelular1 · string | null

Número do 1º telefone celular do correntista.*

Observações:

• Informar o código de área seguido do número do telefone. Exemplo: 11987654321 (representa o telefone número 11 98765-4321)
• O número do 1º telefone celular do correntista pode ter no máximo 20 caracteres.

dadosContato. telefoneCelular2 · string | null

Número do 2º telefone celular do correntista.

Observações:

• Informar o código de área seguido do número do telefone. Exemplo: 11987654321 (representa o telefone número 11 98765-4321)
• O número do 2º telefone celular do correntista pode ter no máximo 20 caracteres.

dadosContato. telefoneFax · string | null

Número do fax do correntista.

Observações:

• Informar o código de área seguido do número do telefone. Exemplo: 11551234567 (representa o telefone número 11 55123-4567)
• O número do fax do correntista pode ter no máximo 20 caracteres.

dadosContato. paginaWeb · string | null

URL da página web do correntista.

Observação:

• A URL da página web do correntista pode ter no máximo 255 caracteres.

dadosEndereco · object

Objeto detalhado do endereço do correntista vinculado à conta.

Show child attributes

dadosEndereco. cep · string | null

Código de endereçamento postal (CEP) do endereço.*

Observações:

• Informar apenas os números do CEP sem os caracteres de formatação (exemplo: ponto, traço, barra, etc.).
• O código de endereçamento postal (CEP) pode ter no máximo 8 caracteres.

dadosEndereco. logradouro · string | null

Logradouro do endereço. Exemplo: Rua das Flores, Avenida Brasil, Travessa Bachmann, etc.*

Observação:

• O logradouro do endereço pode ter no máximo 100 caracteres.

dadosEndereco. nroLogradouro · string | null

Número do endereço.*

Observação:

• O número do endereço pode ter no máximo 15 caracteres.

dadosEndereco. bairro · string | null

Bairro do endereço.

Observação:

• O bairro do endereço pode ter no máximo 50 caracteres.

dadosEndereco. complemento · string | null

Complemento do endereço, utilizado para informações adicionais. Exemplo: Casa, Sala 402, Apartamento 101, Bloco 2, etc.

Observação:

• O complemento do endereço pode ter no máximo 50 caracteres.

dadosEndereco. cidade · string | null

Cidade do endereço.*

Observação:

• A cidade do endereço pode ter no máximo 40 caracteres.

dadosEndereco. uf · string | null

Sigla do estado (UF) do endereço.*

Observação:

• A sigla do estado (UF) pode ter no máximo 2 caracteres.

dadosEndereco. tipoEndereco · enum<integer>

Tipo de endereço.*

Valores: 1 - Residencial 2 - Trabalho

Available options: 1, 2

dadosEndereco. tipoResidencia · enum<integer>

Tipo de residência.

Valores: 1 - Alugada 2 - Propria 3 - Financiada 4 - CasaFuncional

Available options: 1, 2, 3, 4

dadosEndereco. enderecoDesde · string<date-time> | null

Data de início da residência no endereço.

dadosEndereco. enderecoPrincipal · boolean | null

Indicador de endereço principal do correntista.*

dadosEndereco. enderecoCorrespondencia · boolean | null

Indicador de endereço de correspondência.*

dadosEndereco. verificadoInLoco · boolean | null

Indicador de endereço verificado no próprio local.

dadosPF · object

Objeto detalhado dos dados de pessoa física do correntista vinculado à conta.

Observação:

• Quando o 'tipo de pessoa do correntista' (tipoPessoa) for 1 (PF), este objeto deve ser preenchido.

Show child attributes

dadosPF. apelido · string | null

Identificação personalizada para o correntista.

Observação:

• A identificação personalizada para o correntista pode ter no máximo 50 caracteres.

dadosPF. rg · string | null

Número do registro geral (RG).

Observação:

• O número do registro geral (RG) pode ter no máximo 20 caracteres.

dadosPF. rgOrgao · string | null

Orgão Emissor do RG.

Observação:

• O orgão emissor do RG pode ter no máximo 10 caracteres.

dadosPF. rguf · string | null

Sigla do estado (UF) da emissão do RG

Observação:

• A sigla do estado (UF) da emissão do RG pode ter no máximo 2 caracteres.

dadosPF. rgData · string<date-time> | null

Data de expedição do RG.

dadosPF. dtNasc · string<date-time> | null

Data de nascimento.

dadosPF. sexo · string | null

Sexo do correntista.

Observações:

• F = Feminino, M = Masculino.
• O sexo do correntista pode ser 'F' (feminino) ou 'M' (masculino).

dadosPF. nacionalidade · string | null

Pais de origem ou cidadania.

Observação:

• O país de origem ou cidadania pode ter no máximo 40 caracteres.

dadosPF. naturalDeCidade · string | null

Cidade de nascimento.

Observação:

• A cidade de nascimento pode ter no máximo 40 caracteres.

dadosPF. naturalDeUF · string | null

Sigla do estado (UF) de nascimento.

Observação:

• A sigla do estado (UF) de nascimento pode ter no máximo 2 caracteres.

dadosPF. estadoCivil · enum<integer>

Estado civil.

Valores: 1 - Solteiro 2 - Casado 3 - Desquitado 4 - Divorciado 5 - Separado 6 - Viuvo 7 - Outros 8 - Nao Informado 9 - Vinculo Conjugal

Available options: 1, 2, 3, 4, 5, 6, 7, 8, 9

dadosPF. escolaridade · enum<integer>

Escolaridade.

Valores: 1 - Cursando Educação Infantil 2 - Educação Infantil Completa 3 - Cursando Ensino Fundamental 4 - Ensino Fundamental Completo 5 - Cursando Ensino Médio 6 - Ensino Médio Completo 7 - Cursando Ensino Superior 8 - Ensino Superior Completo 9 - Cursando Especialização 10 - Especialização Completa 11 - Cursando Mestrado 12 - Mestrado Completo 13 - Cursando Doutorado 14 - Doutorado Completo 15 - Cursando Pos Doutorado 16 - PosDoutorado Completo 17 - Analfabeto 18 - Sem Instrução Escola

Available options: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18

dadosPF. nomePai · string | null

Nome completo do pai.

Observação:

• O nome completo do pai pode ter no máximo 60 caracteres.

dadosPF. nomeMae · string | null

Nome completo da mãe.

Observação:

• O nome completo da mãe pode ter no máximo 60 caracteres.

dadosPF. nomeConjuge · string | null

Nome completo do conjuge.

Observação:

• O nome completo do conjuge pode ter no máximo 60 caracteres.

dadosPF. dtNascConjuge · string<date-time> | null

Data de nascimento do cônjuge.

dadosPF. cpfConjuge · string | null

Número do CPF do cônjuge.

Observações:

• Informar apenas os números do documento sem os caracteres de formatação (exemplo: ponto, traço, barra, etc.).
• O número do CPF do cônjuge pode ter no máximo 11 caracteres.

dadosPF. rgConjuge · string | null

Número do RG do cônjuge.

Observação:

• O número do RG do cônjuge pode ter no máximo 20 caracteres.

dadosPF. rgOrgaoConjuge · string | null

Orgão emissor do RG do cônjuge.

Observação:

• O orgão emissor do RG do cônjuge pode ter no máximo 10 caracteres.

dadosPF. rgufConjuge · string | null

Sigla do estado (UF) do RG do cônjuge.

Observação:

• A sigla do estado (UF) do RG do cônjuge pode ter no máximo 2 caracteres.

dadosPF. rgDataConjuge · string<date-time> | null

Data de emissão do RG do cônjuge.

dadosPF. nomeArquivoIdentificacao · string | null

Nome do arquivo de identificação do correntista.

Observação:

• O nome do arquivo de identificação do correntista pode ter no máximo 60 caracteres.

dadosPF. arquivoIdentificacao · string | null

A arquivo de identificação do correntista em string base64.

dadosPF. indicadorPEP · enum<integer>

Indicador de pessoa políticamente exposta (PEP).

Valores: 1 - Sim 2 - Não

Available options: 1, 2

dadosPF. renda · number<double> | null

Valor da renda mensal do correntista.

dadosPF. profissao · string | null

Profissão do correntista.

dadosPJ · object

Objeto detalhado dos dados de pessoa jurídica do correntista vinculado à conta.

Observação:

• Quando o 'tipo de pessoa do correntista' (tipoPessoa) for 2 (PJ), este objeto deve ser preenchido.

Show child attributes

dadosPJ. nomeFantasia · string | null

Nome comercial pelo qual a empresa é conhecida publicamente.

Observação:

• O nome fantasia da empresa pode ter no máximo 60 caracteres.

dadosPJ. documentoEstadual · string | null

Número de registro estadual da empresa.

Observação:

• O número de registro estadual da empresa pode ter no máximo 20 caracteres.

dadosPJ. documentoMunicipal · string | null

Número de registro municipal da empresa.

Observação:

• O número de registro municipal da empresa pode ter no máximo 20 caracteres.

dadosPJ. dtAberturaEmpresa · string<date-time> | null

Data de abertura da empresa.

dadosPJ. nomeResponsavelEmpresa · string | null

Nome do responsável pela empresa.

Observação:

• O nome do responsável pela empresa pode ter no máximo 60 caracteres.

dadosPJ. cpfResponsavelEmpresa · string | null

Nº do CPF do responsável pela empresa.

Observações:

• Informar apenas os números do documento sem os caracteres de formatação (exemplo: ponto, traço, barra, etc.).
• O nº do CPF do responsável pela empresa pode ter no máximo 11 caracteres.

dadosPJ. rgResponsavelEmpresa · string | null

Nº do RG do responsável pela empresa.

Observação:

• O nº do RG do responsável pela empresa pode ter no máximo 20 caracteres.

dadosPJ. nomeArquivoContratoSocial · string | null

Nome do arquivo do contrato social da empresa.

dadosPJ. arquivoContratoSocial · string | null

Arquivo do contrato social da empresa em string base64.

dadosPJ. capitalSocial · number<double> | null

Valor do capital social da empresa.

dadosPJ. faturamentoAnual · number<double> | null

Valor do faturamento anual da empresa.

dadosPJ. tipoEmpresa · enum<integer>

Tipo de documento da empresa.

Valores: 1 - MEI 2 - Empresário Individual 3 - Sociedade Limitada Unipessoal 4 - Sociedade Empresária Limitada 5 - Sociedade Simples 6 - Sociedade Anônima 7 - Sociedade Cooperativa 8 - Sociedade de Associação Privada 9 - Condomínio Edifício

Available options: 1, 2, 3, 4, 5, 6, 7, 8, 9

dadosPJ. codigoCnae · string<uuid> | null

Código CNAE da empresa conforme cadastro interno da BMP.

modeloConta · enum<integer>

Available options: 1, 2, 3

Response

200

application/json

Success

sucesso · boolean

mensagem · string | null

numero · string | null

digito · string | null

contaPagamento · string | null