50 - Register Bill

Scopes:

api.ext api.boleto.registrar

cURL

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>"
  },
  "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": {
    "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": {
    "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,
  "recorrencia": {
    "qtd": 123,
    "diaFixoRecorrencia": 123
  }
}
'

200

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

Through this endpoint, the partner can register a boleto. The integrator’s API process registers the boleto with the appropriate agency.

Before registering the boleto, the issuer must have a payee number linked to the account and a registered wallet. Wallet “1” is used for a simple boleto, which is the applicable status for this endpoint, and “9” for a CNAB (National Bank of Brazil).

Payee registration must be performed at the /api/Payee endpoint, and the payee’s link to a wallet must be performed at the /api/Payee/Add Wallet endpoint.

Authorizations

Authorization · string · header · required

Copie 'Bearer ' + token

Headers

IdempotencyKey · string · required

IgnoraHandshake · boolean · default: true · required

(somente em homologação)

Body

application/jsontext/jsonapplication/*+json

beneficiario · object | null

Show child attributes

dadosBoleto · object | null

Show child attributes

pagador · object | null

Show child attributes

sacadorAvalista · object | null

Show child attributes

juros · object | null

Show child attributes

multa · object | null

Show child attributes

desconto · object | null

Show child attributes

descontos · object[] | null

Show child attributes

instrucoesBeneficiario · string[] | null

numeroCarteira · integer<int32>

tipoRegistro · enum<integer> | null

Available options: 1, 2, 3

recorrencia · object | null

Show child attributes

Response

200

application/json

Success

sucesso · boolean

mensagem · string | null

codigoBoleto · string<uuid>

identdNossoNum · string | null

numCodBarras · string | null

numLinhaDigtvl · string | null

numDocTit · string | null