63 - Boletos Outros Bancos

Scopes:

api.ext api.boleto

cURL

cURL

curl --request GET \
  --url https://api.ext.dbs.moneyp.dev.br/api/BoletoOutrosBancos \
  --header 'Authorization: <api-key>'

200

{
  "sucesso": true,
  "mensagem": "<string>",
  "codigoRetorno": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "dadosTitulo": {
    "numLinhaDigtvl": "<string>",
    "numCodBarras": "<string>",
    "nomFantsBenfcrioOr": "<string>",
    "dtVencTit": "2023-11-07T05:31:56Z",
    "cnpjCpfBenfcrioOr": "<string>",
    "vlrTit": 123,
    "tpPessoaBenfcrioOr": "<string>",
    "codPartDestinatario": "<string>",
    "numIdentcTit": "<string>",
    "numRefAtlCadTit": "<string>",
    "indrPgtoParcl": "<string>",
    "tpAutcRecbtVlrDivgte": "<string>",
    "codEspTit": 123,
    "numCtrlPart": "<string>",
    "ispbPartRecbdrPrincipal": "<string>",
    "ispbPartRecbdrAdmtd": "<string>",
    "numCtrlDDA": "<string>",
    "numSeqAtlzCadTit": "<string>",
    "dtHrSitTit": "2023-11-07T05:31:56Z",
    "ispbPartDestinatario": "<string>",
    "nomRzSocBenfcrioOr": "<string>",
    "tpPessoaPagdr": "<string>",
    "cnpjCpfPagdr": "<string>",
    "nomRzSocPagdr": "<string>",
    "codMoedaCNAB": "<string>",
    "dtLimPgtoTit": "2023-11-07T05:31:56Z",
    "indrBloqPgto": "<string>",
    "vlrAbattTit": 123,
    "tpModlCalc": "<string>",
    "sitTitPgto": "<string>",
    "dtHrDDA": "2023-11-07T05:31:56Z",
    "dtMovto": "2023-11-07T05:31:56Z",
    "tpVlr_PercMinTit": "<string>",
    "vlr_PercMinTit": 123,
    "tpVlr_PercMaxTit": "<string>",
    "vlr_PercMaxTit": 123,
    "totalBaixasParciais": 123,
    "tpIdentcSacdrAvalst": "<string>",
    "identcSacdrAvalst": "<string>",
    "nom_RzSocSacdrAvalst": "<string>",
    "emissor": "<string>",
    "result": 123,
    "tipo": 1
  },
  "juros": {
    "codJurosTit": "<string>",
    "dtJurosTit": "2023-11-07T05:31:56Z",
    "vlrPercJurosTit": 123,
    "total": 123
  },
  "multa": {
    "codMultaTit": "<string>",
    "dtMultaTit": "2023-11-07T05:31:56Z",
    "vlrPercMultaTit": 123,
    "total": 123
  },
  "descontos": [
    {
      "codDesctTit": "<string>",
      "dtDesctTit": "2023-11-07T05:31:56Z",
      "vlrPercDesctTit": 123,
      "total": 123
    }
  ],
  "validacoes": [
    {
      "mensagem": "<string>"
    }
  ],
  "sucessoRetornoCM": true,
  "origemConsulta": 1,
  "vlrTitTotal": 123
}

Por meio deste endpoint, o parceiro pode realizar uma consulta de boletos que possuem registro em outra instituição financeira.

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/BoletoOutrosBancos	Operador não informado
/api/BoletoOutrosBancos	Operador sem parceiro configurado
/api/BoletoOutrosBancos	O limite de consulta de boletos por hora foi atingido. Tente novamente mais tarde

Autorizações

Authorization · string · header · obrigatório

Copie 'Bearer ' + token

Parâmetros de consulta

LinhaDigitavel · string

Sequência numérica digitável presente no boleto bancário.

CodigoBarras · string

Sequência numérica que corresponde ao código de barras impresso no boleto bancário.

Resposta

200

application/json

Success

sucesso · boolean

mensagem · string | null

codigoRetorno · string<uuid>

dadosTitulo · object

Show child attributes

juros · object

Show child attributes

multa · object

Show child attributes

descontos · object[] | null

Show child attributes

validacoes · object[] | null

Show child attributes

sucessoRetornoCM · boolean

origemConsulta · enum<integer>

Opções disponíveis: 1, 2

vlrTitTotal · number<double>