55 - Registrar Boleto

cURL

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/Registrar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "beneficiario": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>",
    "tipoConta": 1,
    "modeloConta": 1
  },
  "dadosBoleto": {
    "dtVencimento": "2023-11-07T05:31:56Z",
    "dtLimPgto": "2023-11-07T05:31:56Z",
    "vlrTitulo": 123,
    "numDocTit": "<string>",
    "identdNossoNum": "<string>",
    "codEspTit": 123,
    "dtEmissao": "2023-11-07T05:31:56Z",
    "vlrAbatimento": 123,
    "numeroDocumento": "<string>"
  },
  "pagador": {
    "tipoPessoa": 1,
    "documentoFederal": "<string>",
    "nomeRazao": "<string>",
    "nomeFantasia": "<string>",
    "logradouro": "<string>",
    "cidade": "<string>",
    "uf": "<string>",
    "cep": "<string>",
    "bairro": "<string>",
    "numero": "<string>",
    "complemento": "<string>",
    "email": "<string>",
    "telefone": "<string>"
  },
  "sacadorAvalista": {
    "tipo": 0,
    "identificador": "<string>",
    "nomeSacadorAvalista": "<string>"
  },
  "juros": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "multa": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "desconto": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "descontos": [
    {
      "data": "2023-11-07T05:31:56Z",
      "codigo": "<string>",
      "vlr": 123
    }
  ],
  "instrucoesBeneficiario": [
    "<string>"
  ],
  "numeroCarteira": 123,
  "tipoRegistro": 1,
  "recorrencia": {
    "tipo": 1,
    "modelo": 1,
    "qtd": 123,
    "diaFixoRecorrencia": 123
  }
}
'

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "identdNossoNum": "<string>",
  "numCodBarras": "<string>",
  "numLinhaDigtvl": "<string>",
  "numDocTit": "<string>"
}

POST

api

Boleto

Registrar

cURL

curl --request POST \
  --url https://api.ext.dbs.moneyp.dev.br/api/Boleto/Registrar \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --header 'IgnoraHandshake: <ignorahandshake>' \
  --data '
{
  "beneficiario": {
    "agencia": "<string>",
    "agenciaDigito": "<string>",
    "conta": "<string>",
    "contaDigito": "<string>",
    "contaPgto": "<string>",
    "tipoConta": 1,
    "modeloConta": 1
  },
  "dadosBoleto": {
    "dtVencimento": "2023-11-07T05:31:56Z",
    "dtLimPgto": "2023-11-07T05:31:56Z",
    "vlrTitulo": 123,
    "numDocTit": "<string>",
    "identdNossoNum": "<string>",
    "codEspTit": 123,
    "dtEmissao": "2023-11-07T05:31:56Z",
    "vlrAbatimento": 123,
    "numeroDocumento": "<string>"
  },
  "pagador": {
    "tipoPessoa": 1,
    "documentoFederal": "<string>",
    "nomeRazao": "<string>",
    "nomeFantasia": "<string>",
    "logradouro": "<string>",
    "cidade": "<string>",
    "uf": "<string>",
    "cep": "<string>",
    "bairro": "<string>",
    "numero": "<string>",
    "complemento": "<string>",
    "email": "<string>",
    "telefone": "<string>"
  },
  "sacadorAvalista": {
    "tipo": 0,
    "identificador": "<string>",
    "nomeSacadorAvalista": "<string>"
  },
  "juros": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "multa": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "desconto": {
    "data": "2023-11-07T05:31:56Z",
    "codigo": "<string>",
    "vlr": 123
  },
  "descontos": [
    {
      "data": "2023-11-07T05:31:56Z",
      "codigo": "<string>",
      "vlr": 123
    }
  ],
  "instrucoesBeneficiario": [
    "<string>"
  ],
  "numeroCarteira": 123,
  "tipoRegistro": 1,
  "recorrencia": {
    "tipo": 1,
    "modelo": 1,
    "qtd": 123,
    "diaFixoRecorrencia": 123
  }
}
'

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoBoleto": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "identdNossoNum": "<string>",
  "numCodBarras": "<string>",
  "numLinhaDigtvl": "<string>",
  "numDocTit": "<string>"
}

Por meio deste endpoint, o parceiro pode efetuar o registro de um boleto. O processo da API por parte do integrador, faz com que o boleto seja registrado junto ao órgão responsável. Antes de efetuar o registro do boleto é necessário que o emissor tenha um número de cedente vinculado a conta e uma carteira registrada, sendo carteira “1” para boleto simples que é a situação que se aplica neste endpoint e “9” para CNAB. O registro do cedente deve ser realizado no endpoint /api/Cedente e o vínculo do cedente a uma carteira deve ser realizado no endpoint /api/Cedente/AdicionarCarteira.

Mostrar Mensagens de requisições com erro

O retorno de uma requisição com status HTTP 400 (Bad Request) pode incluir as seguintes mensagens de erro:

Endpoint	Mensagem de erro
/api/Boleto/Registrar	Conta
/api/Boleto/Registrar	Operador sem parceiro cadastrado
/api/Boleto/Registrar	Parceiro não autorizado para esta conta
/api/Boleto/Registrar	O modelo conta deve ser informado
/api/Boleto/Registrar	A conta não pode ser do modelo ‘Conta
/api/Boleto/Registrar	Não foi possível registrar o boleto. A conta está bloqueada
/api/Boleto/Registrar	Não foi possivel obter os dados da conta para registro do boleto
/api/Boleto/Registrar	A carteira está desativada
/api/Boleto/Registrar	Não existe cedente parametrizado para esta conta
/api/Boleto/Registrar	Carteira não encontrada
/api/Boleto/Registrar	Não existe cedente parametrizado para esta conta e carteira
/api/Boleto/Registrar	Situação do cedente não permite registro de boleto
/api/Boleto/Registrar	Não foram identificados pagadores para a emissão de boleto

Authorizations

Authorization

string

header

required

Copie 'Bearer ' + token

Headers

IdempotencyKey

string

required

IgnoraHandshake

boolean

default:true

required

(somente em homologação)

Body

beneficiario

object

Mostrar atributos filhos

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

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

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

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

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

beneficiario.tipoConta

enum<integer>

Tipo da conta.*

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

Opções disponíveis:

1,

2,

3,

4

beneficiario.modeloConta

enum<integer>

Modelo da conta.*

Valores: 1 - Movimento 2 - Escrow 3 - Vinculada

Opções disponíveis:

1,

2,

3

dadosBoleto

object

Mostrar atributos filhos

dadosBoleto.dtVencimento

string<date-time>

Data de vencimento do título.*

dadosBoleto.dtLimPgto

string<date-time> | null

Data limite para pagamento do título.

dadosBoleto.vlrTitulo

number<double>

Valor do título.*

Observação:

O 'valor do título' (vlrTitulo) deve ser maior que zero.

dadosBoleto.numDocTit

string | null

Número do documento do título utilizado pelo cedente.

dadosBoleto.identdNossoNum

string | null

Identificador do título no banco – o “Nosso Número”.

dadosBoleto.codEspTit

integer<int32>

Código para identificar o tipo de título de cobrança. Códigos adotados pela FEBRABAN.*

Códigos para identificar o 'tipo de título de cobrança' (codEspTit):

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; 33 = Boleto de Depósito e Aporte; 99 = Outros

dadosBoleto.dtEmissao

string<date-time> | null

Data de emissão do título.

dadosBoleto.vlrAbatimento

number<double>

Valor total dos abatimentos para o título.

Observação:

O 'valor total dos abatimentos para o título' (vlrAbatimento) deve ser informado quando o 'desconto principal' (desconto) ou algum 'desconto adicional' (descontos) tiver sido informado.

dadosBoleto.numeroDocumento

string | null

Número do documento para livre controle do cedente.

pagador

object

Mostrar atributos filhos

pagador.tipoPessoa

enum<integer>

Opções disponíveis:

1,

2

pagador.documentoFederal

string | null

pagador.nomeRazao

string | null

pagador.nomeFantasia

string | null

pagador.logradouro

string | null

pagador.cidade

string | null

pagador.uf

string | null

pagador.cep

string | null

pagador.bairro

string | null

pagador.numero

string | null

pagador.complemento

string | null

pagador.email

string | null

pagador.telefone

string | null

sacadorAvalista

object

Mostrar atributos filhos

sacadorAvalista.tipo

enum<integer>

Tipo de sacador avalista.

Valores: 0 - Isento 1 - CPF 2 - CNPJ 3 - PIS/PASEP 9 - Outros

Opções disponíveis:

0,

1,

2,

3,

9

sacadorAvalista.identificador

string | null

Identificador do sacador avalista.

sacadorAvalista.nomeSacadorAvalista

string | null

Nome do sacador avalista.

juros

object

Mostrar atributos filhos

juros.data

string<date-time> | null

Data associada ao item calculável.

juros.codigo

string | null

Código do item calculável.

juros.vlr

number<double>

Valor do item calculável.

multa

object

Mostrar atributos filhos

multa.data

string<date-time> | null

Data associada ao item calculável.

multa.codigo

string | null

Código do item calculável.

multa.vlr

number<double>

Valor do item calculável.

desconto

object

Mostrar atributos filhos

desconto.data

string<date-time> | null

Data associada ao item calculável.

desconto.codigo

string | null

Código do item calculável.

desconto.vlr

number<double>

Valor do item calculável.

descontos

object[] | null

Mostrar atributos filhos

descontos.data

string<date-time> | null

Data associada ao item calculável.

descontos.codigo

string | null

Código do item calculável.

descontos.vlr

number<double>

Valor do item calculável.

instrucoesBeneficiario

string[] | null

numeroCarteira

integer<int32>

tipoRegistro

enum<integer>

Opções disponíveis:

1,

2,

3

recorrencia

object

Mostrar atributos filhos

recorrencia.tipo

enum<integer>

Tipo de recorrencia.

Valores: 1 - Semanal 2 - Quinzenal 3 - Mensal 4 - Trimestral 5 - Bimestral 6 - Anual 7 - Semestral

Opções disponíveis:

1,

2,

3,

4,

5,

6,

7

recorrencia.modelo

enum<integer>

Modelo de recorrencia.

Valores: 1 - Parcelado 2 - Recorrente

Opções disponíveis:

1,

2

recorrencia.qtd

integer<int32> | null

Número de recorrências.

recorrencia.diaFixoRecorrencia

integer<int32> | null

Dia do mês fixo da recorrência.

Response

Success

sucesso

boolean

mensagem

string | null

codigoBoleto

string<uuid>

identdNossoNum

string | null

numCodBarras

string | null

numLinhaDigtvl

string | null

numDocTit

string | null

54 - Pagar Boleto 56 - Consultar Registro de Boleto

⌘I

Guia Inicial

Guia do Desenvolvedor

Referências de API

Layouts de CNAB

55 - Registrar Boleto

Authorizations

Headers

Body

Response