curl --request POST \
  --url https://api.bmpdigital.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>",
    "codigoReguaComunicacao": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tipoReguaComunicacao": 0,
    "tipoProtesto": 0,
    "diasProtesto": 123,
    "tipoNegativacao": 0,
    "diasNegativacao": 123,
    "serasa": true,
    "boaVista": true,
    "codigoParceiro": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "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
}'
{
  "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.

Authorizations

​
Authorization
string
header
required

Copie 'Bearer ' + token

Headers

​
IdempotencyKey
string
required

Chave única para garantir que uma operação seja executada apenas uma vez.

​
IgnoraHandshake
boolean
default:true
required

(somente em homologação)

Body

​
beneficiario
object
​
dadosBoleto
object
​
pagador
object
​
sacadorAvalista
object
​
juros
object
​
multa
object
​
desconto
object
​
descontos
object[] | null
​
instrucoesBeneficiario
string[] | null
​
numeroCarteira
integer
​
tipoRegistro
enum<integer>
Available options:
1,
2,
3

Response

200 - application/json
Success
​
sucesso
boolean

Indica se a operação foi realizada com sucesso.

​
mensagem
string | null

Descrição detalhada do resultado da operação, incluindo informações sobre erros ou mensagens complementares.

​
codigoBoleto
string

Código UUID identificador do boleto registrado.

​
identdNossoNum
string | null

Número de Controle do Cedente para identificar o Título.

​
numCodBarras
string | null

Código de barras do Boleto de Pagamento.

​
numLinhaDigtvl
string | null

Linha digitável do Boleto de Pagamento.

​
numDocTit
string | null

Número do Documento do Título utilizado pelo Cedente.

Esta página foi útil?