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/Correntista/Atualizar \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--header 'IgnoraHandshake: <ignorahandshake>' \
--data '
{
"conta": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>",
"tipoConta": 1,
"modeloConta": 1
},
"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
}
}
'{
"sucesso": true,
"mensagem": "<string>"
}51 - Atualizar Cadastro de Correntista
Scopes:
api.ext api.correntista.atualizarcurl --request POST \
--url https://api.ext.dbs.moneyp.dev.br/api/Correntista/Atualizar \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--header 'IgnoraHandshake: <ignorahandshake>' \
--data '
{
"conta": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>",
"tipoConta": 1,
"modeloConta": 1
},
"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
}
}
'{
"sucesso": true,
"mensagem": "<string>"
}Mostrar Mensagens de requisições com erro
Mostrar Mensagens de requisições com erro
| Endpoint | Mensagem de erro |
|---|---|
| /api/Correntista/Atualizar | Operador não configurado para esta integração |
| /api/Correntista/Atualizar | Operador não autorizado para essa operação |
| /api/Correntista/Atualizar | Necessário informar dados de contato e endereço |
| /api/Correntista/Atualizar | Necessário informar o número de celular: |
| /api/Correntista/Atualizar | Necessário informar o e-mail: |
| /api/Correntista/Atualizar | Necessário informar o CEP: |
| /api/Correntista/Atualizar | Necessário informar o endereço: |
| /api/Correntista/Atualizar | Necessário informar o número: |
| /api/Correntista/Atualizar | Necessário informar a cidade: |
| /api/Correntista/Atualizar | Necessário informar a UF: |
| /api/Correntista/Atualizar | Necessário informar o tipo de endereço: |
| /api/Correntista/Atualizar | Necessário informar se é o endereço principal: |
| /api/Correntista/Atualizar | Necessário informar se é o endereço correspondência: |
| /api/Correntista/Atualizar | A data do endereço desde não pode ser superior a data atual |
| /api/Correntista/Atualizar | Necessário informar Conta + ContaDigito ou ContaPgto |
| /api/Correntista/Atualizar | Conta inválida |
| /api/Correntista/Atualizar | Situação da conta inválida |
| /api/Correntista/Atualizar | Conta != Ativa |
| /api/Correntista/Atualizar | Operador não encontrado |
| /api/Correntista/Atualizar | Parceiro não autorizado para esta conta |
| /api/Correntista/Atualizar | Conta não encontrada |
| /api/Correntista/Atualizar | Correntista não cadastrado |
| /api/Correntista/Atualizar | Correntista não está vinculado a conta informada |
| /api/Correntista/Atualizar | Documento Federal inválido |
| /api/Correntista/Atualizar | Parceiro não encontrado |
Authorizations
Copie 'Bearer ' + token
Headers
(somente em homologação)
Body
Objeto detalhado da conta bancária.*
Mostrar atributos filhos
Mostrar atributos filhos
Número da agência bancária.*
Observações:
- O número da agência pode ter no máximo 4 caracteres.
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.
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.
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.
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.
Tipo da conta.*
Valores: 1 - Corrente 2 - Poupanca 3 - Pagamento 4 - Salario
1, 2, 3, 4 Modelo da conta.*
Valores: 1 - Movimento 2 - Escrow 3 - Vinculada
1, 2, 3 Objeto detalhado 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.
Esta página foi útil?