curl --request POST \
  --url https://api.bmpdigital.moneyp.dev.br/AgendaRecebivel/ConsultarBoletos \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'IdempotencyKey: <idempotencykey>' \
  --data '{
  "dto": {
    "codigoProposta": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "codigoOperacao": "<string>"
  },
  "dtoConsultaBoletos": {
    "numerosBoletos": [
      123
    ],
    "trazerBoletosCancelados": true
  }
}'
{
  "msg": "<string>",
  "hasError": true,
  "messages": [
    {
      "messageType": 1,
      "code": "<string>",
      "context": "<string>",
      "description": "<string>",
      "field": "<string>"
    }
  ],
  "boletos": [
    {
      "numeroBoleto": 123,
      "numeroProposta": 123,
      "liquidacao": true,
      "parcelas": "<string>",
      "descricao": "<string>",
      "dtInclusao": "2023-11-07T05:31:56Z",
      "dtVencimento": "2023-11-07T05:31:56Z",
      "dtCancelamento": "2023-11-07T05:31:56Z",
      "dtExpiracao": "2023-11-07T05:31:56Z",
      "dtCredito": "2023-11-07T05:31:56Z",
      "valorBoleto": 123,
      "vlrPago": 123,
      "impressao": "<string>",
      "linhaDigitavel": "<string>",
      "documentoFederalCliente": "<string>",
      "cliente": "<string>",
      "parceiro": "<string>",
      "qrCode": {
        "emv": "<string>",
        "imagem": "<string>"
      }
    }
  ]
}

Permite a consulta dos boletos gerados para a proposta informada.

Authorizations

​
Authorization
string
header
required

Informe o token

Headers

​
IdempotencyKey
string
required

Body

​
dto
object
​
dtoConsultaBoletos
object

Response

200
text/plain
OK
​
msg
string | null
​
hasError
boolean
​
messages
object[] | null
​
boletos
object[] | null

Esta página foi útil?