Guia Inicial
Guia do Desenvolvedor
Referências de API
- POST54 - Pagar Boleto
- POST55 - Registrar Boleto
- GET56 - Consultar Registro de Boleto
- GET57 - Consultar Boletos Registrados
- POST58 - Cancelar Registro
- GET59 - Consultar Cancelamento de Boleto
- POST60 - Atualizar Boleto
- GET61 - Consultar Alterações Realizadas
- GET62 - Consultar a Última Alteração do Boleto
- GET63 - Boletos Outros Bancos
- GET64 - Consultar Cedente
- POST65 - Incluir Cedente
- POST66 - Vincular Carteira
- GET67 - Imprimir Boleto
- POST
Layouts de CNAB
curl --request POST \
--url https://api.ext.dbs.moneyp.dev.br/api/Cedente/AdicionarCarteira \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--header 'IgnoraHandshake: <ignorahandshake>' \
--data '
{
"numeroCedente": 123,
"conta": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>",
"tipoConta": 1,
"modeloConta": 1
},
"carteira": {
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoCedente": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoCarteira": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numero": 123,
"descricao": "<string>",
"tipoJuros": 1,
"vlrJuros": 123,
"tipoMulta": 1,
"vlrMulta": 123,
"diasLimitePagamento": 123,
"especie": 1,
"tipoPagamento": 1,
"origemNossoNumero": 1,
"cnabHabilitado": true,
"codigoEmpresaCNAB": "<string>",
"codCartTit": 1,
"hibrido": true,
"tipoDesconto": 0,
"valorDesconto1": 123,
"valorDesconto2": 123,
"valorDesconto3": 123,
"qtdDiasDesconto1": 123,
"qtdDiasDesconto2": 123,
"qtdDiasDesconto3": 123
}
}
'{
"sucesso": true,
"mensagem": "<string>",
"codigoEmpresaCNAB": "<string>"
}66 - Vincular Carteira
Scopes:
api.ext api.cedente.incluirCarteiracurl --request POST \
--url https://api.ext.dbs.moneyp.dev.br/api/Cedente/AdicionarCarteira \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'IdempotencyKey: <idempotencykey>' \
--header 'IgnoraHandshake: <ignorahandshake>' \
--data '
{
"numeroCedente": 123,
"conta": {
"agencia": "<string>",
"agenciaDigito": "<string>",
"conta": "<string>",
"contaDigito": "<string>",
"contaPgto": "<string>",
"tipoConta": 1,
"modeloConta": 1
},
"carteira": {
"codigo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoCedente": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"codigoCarteira": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"numero": 123,
"descricao": "<string>",
"tipoJuros": 1,
"vlrJuros": 123,
"tipoMulta": 1,
"vlrMulta": 123,
"diasLimitePagamento": 123,
"especie": 1,
"tipoPagamento": 1,
"origemNossoNumero": 1,
"cnabHabilitado": true,
"codigoEmpresaCNAB": "<string>",
"codCartTit": 1,
"hibrido": true,
"tipoDesconto": 0,
"valorDesconto1": 123,
"valorDesconto2": 123,
"valorDesconto3": 123,
"qtdDiasDesconto1": 123,
"qtdDiasDesconto2": 123,
"qtdDiasDesconto3": 123
}
}
'{
"sucesso": true,
"mensagem": "<string>",
"codigoEmpresaCNAB": "<string>"
}Mostrar ENUMs corretos para o campo carteira.tipoJuros
Mostrar ENUMs corretos para o campo carteira.tipoJuros
- Código Multa: 1 - Valor Fixo / 2 - Percentual / 3 - Isenta
- Código Juros: 1 - Valor (dias corridos) / 3 - Percentual ao mês (dias corridos) / 5 - Isento / 6 - Valor (dia útil)
- Código Desconto: 0 - Isento / 1 - Valor fixo até a data informada / 2 - Percentual até a data informada / 3 - Valor por antecipação dia corrido / 5 - Percentual por antecipação dia corrido
Mostrar Mensagens de requisições com erro
Mostrar Mensagens de requisições com erro
| Endpoint | Mensagem de erro |
|---|---|
| /api/Cedente/AdicionarCarteira | Informe uma carteira |
| /api/Cedente/AdicionarCarteira | Conta |
| /api/Cedente/AdicionarCarteira | Operador não encontrado |
| /api/Cedente/AdicionarCarteira | Parceiro não autorizado para esta conta |
| /api/Cedente/AdicionarCarteira | Cedente não cadastrado ou inativo |
| /api/Cedente/AdicionarCarteira | Carteira não cadastrada |
| /api/Cedente/AdicionarCarteira | Cedente informado não está relacionado com a Agencia/Conta informada |
| /api/Cedente/AdicionarCarteira | Cedente não encontrado |
| /api/Cedente/AdicionarCarteira | Numero da Carteira não encontrada |
Authorizations
Copie 'Bearer ' + token
Headers
(somente em homologação)
Body
Número de identificação do cedente para o qual a carteira será cadastrada.*
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 da carteira.*
Mostrar atributos filhos
Mostrar atributos filhos
Codigo do cedente carteira.
Codigo do cedente.
Codigo da carteira.
Número de identificação da Carteira.
Descrição da Carteira.
Tipo de juros.*
Valores: 1 - CPF 2 - CNPJ 3 - TELEFONE 6 - EMAIL 8 - EVP
1, 2, 3, 5, 6, 8 Valor ou percentual aplicado de juros, dependendo da natureza de juro informada.
Tipo de multa.*
Valores: 1 - Valor fixo 2 - Percentual 3 - Isenta
1, 2, 3 Valor ou percentual aplicado de multa, dependendo da natureza de multa informada.
Número de dias de limite para pagamento após a data de vencimento do título, permitindo definir o período de tolerância para o pagamento.
Espécie.*
Valores: 1 - CH Cheque 2 - DM Duplicata Mercantil 3 - DMI Duplicata Mercantil Indicação 4 - DS Duplicata de Serviço 5 - DSI Duplicata de Serviço Indicação 6 - DR Duplicata Rural 7 - LC Letra de Câmbio 8 - NCC Nota de Crédito Comercial 9 - NCE Nota de Crédito Exportação 10 - NCI Nota de Crédito Industrial 11 - NCR Nota de Crédito Rural 12 - NP Nota Promissória 13 - NPR Nota Promissória Rural 14 - TM Triplicata Mercantil 15 - TS Triplicata de Serviço 16 - NS Nota de Seguro 17 - RC Recibo 18 - FAT Bloqueto 19 - ND Nota de Débito 20 - AP Apólice de Seguro 21 - ME Mensalidade Escolar 22 - PC Parcela de Consórcio 23 - NF Nota Fiscal 24 - DD Documento de Dívida 25 - Cédula de Produto Rural 26 - Warrant 27 - Dívida Ativa de Estado 28 - Dívida Ativa de Município 29 - Dívida Ativa da União 30 - Encargos condominiais 31 - Cartão de Crédito 32 - Boleto proposta 99 - Outros
1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 99 Tipo de Pagamento.*
Valores: 1 - A vista 2 - Vencimento determinado 3 - Carnê
1, 2, 3 Origem nosso numero.*
Valores: 1 - BMP 2 - Cliente
1, 2 Indica se a carteira está habilitada para gerar arquivos CNAB.
Código da empresa no padrão CNAB, utilizado para identificá-la em arquivos no padrão CNAB.
Modalidade.*
Valores: 1 - Cobrança Simples 2 - Cobrança Vinculada 3 - Cobrança Caucionada 4 - Cobrança Descontada 5 - Cobrança Vendor
1, 2, 3, 4, 5 Indica se a carteira suporta uma modalidade híbrida de cobrança.
Tipo de desconto.*
Valores: 0 - Isento 1 - Valor fixo até a data informada 2 - Percentual até a data informada 3 - Valor por antecipação (dias corridos) 4 - Valor por antecipação (dias úteis) 5 - Percentual por antecipação (dias corridos) 6 - Percentual por antecipação (dias úteis) 7 - Cancelamento Desconto
0, 1, 2, 3, 4, 5, 6, 7 Valor ou percentual do 1º desconto.
Valor ou percentual do 2º desconto.
Valor ou percentual do 3º desconto.
Quantidade de dias de antecipação para aplicação do 1º desconto.
Quantidade de dias de antecipação para aplicação do 2º desconto.
Quantidade de dias de antecipação para aplicação do 3º desconto.
Esta página foi útil?