Guia Inicial
Guia do Desenvolvedor
Referências de API
- GET41 - Consultar Comprovante
- GET42 - Consultar Saldo
- GET43 - Consultar Extrato
- GET44 - Consultar Tarifas
- GET45 - Consultar Conta por Documento
- DEL46 - Cancelar Pedido de Encerramento de Conta
- GET47 - Consulta Encerramento de Conta
- POST48 - Pedido de Encerramento de Conta
- GET49 - Movimentação de Conta
- POST50 - Criar Conta
- POST51 - Atualizar Cadastro de Correntista
- PUT52 - Atualizar Favorecido
- POST53 - Cadastro de Favorecido
- GET
Layouts de CNAB
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
}
'{
"sucesso": true,
"mensagem": "<string>",
"numero": "<string>",
"digito": "<string>",
"contaPagamento": "<string>"
}50 - Criar Conta
Scopes:
api.ext api.conta.criarcurl --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
}
'{
"sucesso": true,
"mensagem": "<string>",
"numero": "<string>",
"digito": "<string>",
"contaPagamento": "<string>"
}Mostrar Mensagens de requisições com erro
Mostrar Mensagens de requisições com erro
| Endpoint | Mensagem de erro |
|---|---|
| /api/Conta/ | O campo modelo conta é inválido |
| /api/Conta/ | O campo modelo conta não pode ser do tipo conta vinculada |
| /api/Conta/ | Parceiro não configurado |
| /api/Conta/ | O campo modelo cobrança taxa é inválido |
| /api/Conta/ | O campo aprovação automática favorecido é inválido |
| /api/Conta/ | Correntista não informado |
| /api/Conta/ | Não foi possível concluir o cadastro do correntista informado |
| /api/Conta/ | Tipo de geração de conta não autorizado |
| /api/Conta/ | Número da conta deve ser informado |
| /api/Conta/ | Número da conta fora dos limites autorizados para o parceiro |
| /api/Conta/ | Número da conta não pode ser informado para geração sequencial |
| /api/Conta/ | Tipo de conta inválido |
| /api/Conta/ | Tipo de pessoa não informado |
| /api/Conta/ | O parceiro deve utilizar o fluxo de onboarding para a abertura de contas |
| /api/Conta/ | Número do banco deve ser informado |
| /api/Conta/ | Apenas algarismos devem ser informados no número do banco |
| /api/Conta/ | Banco informado não é válido |
| /api/Conta/ | Banco não encontrado |
| /api/Conta/ | Número da agência deve ser informado |
| /api/Conta/ | Apenas algarismos devem ser informados no número da agência |
| /api/Conta/ | Agência não encontrada |
| /api/Conta/ | A agência informada não existe |
| /api/Conta/ | Subparceiro inválido |
| /api/Conta/ | Está conta já esta vinculada |
Authorizations
Copie 'Bearer ' + token
Headers
(somente em homologação)
Body
Número do banco.*
Observação:
- O 'número do banco' (
numeroBanco) pode ter no máximo 3 caracteres.
Número da agência.*
Observação:
- O número da agência pode ter no máximo 4 caracteres.
- Valor padrão: '0001'
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.
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.
Informações adicionais sobre a conta.
Tipo de geração de conta.*
Observação:
- Valor padrão: '0'
Valores: 0 - Manual 1 - Sequencial
0, 1 Modelo de cobrança de taxa.*
Observação:
- Valor padrão: '1'
Valores: 0 - Desativado 1 - Parceiro 1 - Cliente
0, 1, 2 Tipo de conta.*
Observação:
- Valor padrão: '3'
Valores: -1 - CACC 2 - SVGS 3 - TRAN 4 - SLRY
Objeto detalhado da identificação do correntista vinculado à conta.*
Mostrar atributos filhos
Mostrar atributos filhos
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.
Nome completo do correntista.*
Observação:
- O nome do correntista pode ter no máximo 100 caracteres.
Tipo de pessoa.
Valores: 1 - PF 2 - PJ
Situacao.
Valores: 1 - Ativado 2 - Desativado
1, 2 Objeto detalhado do contato do correntista vinculado à conta.*
Mostrar atributos filhos
Mostrar atributos filhos
Email de contato do correntista.*
Observação:
- O email de contato do correntista pode ter no máximo 60 caracteres.
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.
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.
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.
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.
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.
URL da página web do correntista.
Observação:
- A URL da página web do correntista pode ter no máximo 255 caracteres.
Objeto detalhado do endereço do correntista vinculado à conta.
Mostrar atributos filhos
Mostrar atributos filhos
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.
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.
Número do endereço.*
Observação:
- O número do endereço pode ter no máximo 15 caracteres.
Bairro do endereço.
Observação:
- O bairro do endereço pode ter no máximo 50 caracteres.
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.
Cidade do endereço.*
Observação:
- A cidade do endereço pode ter no máximo 40 caracteres.
Sigla do estado (UF) do endereço.*
Observação:
- A sigla do estado (UF) pode ter no máximo 2 caracteres.
Tipo de endereço.*
Valores: 1 - Residencial 2 - Trabalho
1, 2 Tipo de residência.
Valores: 1 - Alugada 2 - Propria 3 - Financiada 4 - CasaFuncional
1, 2, 3, 4 Data de início da residência no endereço.
Indicador de endereço principal do correntista.*
Indicador de endereço de correspondência.*
Indicador de endereço verificado no próprio local.
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.
Mostrar atributos filhos
Mostrar atributos filhos
Identificação personalizada para o correntista.
Observação:
- A identificação personalizada para o correntista pode ter no máximo 50 caracteres.
Número do registro geral (RG).
Observação:
- O número do registro geral (RG) pode ter no máximo 20 caracteres.
Orgão Emissor do RG.
Observação:
- O orgão emissor do RG pode ter no máximo 10 caracteres.
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.
Data de expedição do RG.
Data de nascimento.
Sexo do correntista.
Observações:
- F = Feminino, M = Masculino.
- O sexo do correntista pode ser 'F' (feminino) ou 'M' (masculino).
Pais de origem ou cidadania.
Observação:
- O país de origem ou cidadania pode ter no máximo 40 caracteres.
Cidade de nascimento.
Observação:
- A cidade de nascimento pode ter no máximo 40 caracteres.
Sigla do estado (UF) de nascimento.
Observação:
- A sigla do estado (UF) de nascimento pode ter no máximo 2 caracteres.
Estado civil.
Valores: 1 - Solteiro 2 - Casado 3 - Desquitado 4 - Divorciado 5 - Separado 6 - Viuvo 7 - Outros 8 - Nao Informado 9 - Vinculo Conjugal
1, 2, 3, 4, 5, 6, 7, 8, 9 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
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18 Nome completo do pai.
Observação:
- O nome completo do pai pode ter no máximo 60 caracteres.
Nome completo da mãe.
Observação:
- O nome completo da mãe pode ter no máximo 60 caracteres.
Nome completo do conjuge.
Observação:
- O nome completo do conjuge pode ter no máximo 60 caracteres.
Data de nascimento do cônjuge.
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.
Número do RG do cônjuge.
Observação:
- O número do RG do cônjuge pode ter no máximo 20 caracteres.
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.
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.
Data de emissão do RG do cônjuge.
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.
A arquivo de identificação do correntista em string base64.
Indicador de pessoa políticamente exposta (PEP).
Valores: 1 - Sim 2 - Não
1, 2 Valor da renda mensal do correntista.
Profissão do correntista.
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.
Mostrar atributos filhos
Mostrar atributos filhos
Nome comercial pelo qual a empresa é conhecida publicamente.
Observação:
- O nome fantasia da empresa pode ter no máximo 60 caracteres.
Número de registro estadual da empresa.
Observação:
- O número de registro estadual da empresa pode ter no máximo 20 caracteres.
Número de registro municipal da empresa.
Observação:
- O número de registro municipal da empresa pode ter no máximo 20 caracteres.
Data de abertura da empresa.
Nome do responsável pela empresa.
Observação:
- O nome do responsável pela empresa pode ter no máximo 60 caracteres.
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.
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.
Nome do arquivo do contrato social da empresa.
Arquivo do contrato social da empresa em string base64.
Valor do capital social da empresa.
Valor do faturamento anual da empresa.
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
1, 2, 3, 4, 5, 6, 7, 8, 9 Código CNAE da empresa conforme cadastro interno da BMP.
1, 2, 3 Esta página foi útil?