List recurring charges by Bacen filters (scoped to the account)

​
Query Parameters
  • inicio
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • fim
    Type: string Format: date-time
    required

    the date-time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

  • cpf
    Type: string
  • cnpj
    Type: string
  • status
    Type: string enum
    values
    • CRIADA
    • ATIVA
    • CONCLUIDA
    • EXPIRADA
    • REJEITADA
    • CANCELADA
  • idRec
    Type: string
  • convenio
    Type: string
  • paginacao.paginaAtual
    Type: integer Format: int32

    Signed 32-bit integers (commonly used integer type).

  • paginacao.itensPorPagina
    Type: integer Format: int32

    Signed 32-bit integers (commonly used integer type).

Responses
  • application/json
  • 400

    Requisição inválida

  • 403

    Acesso negado — credencial sem o escopo exigido pela operação ou certificado rejeitado. Respondido no gateway de exposição (Bacen: AcessoNegado)

  • 503

    Serviço temporariamente indisponível (Bacen: ServicoIndisponivel)

Request Example for get/api/cobr
curl 'http://localhost:8080/api/cobr?inicio=&fim=' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "parametros": {
    "inicio": "2026-09-16T19:14:18.843Z",
    "fim": "2026-09-16T19:14:18.843Z",
    "idRec": "string",
    "cpf": "string",
    "cnpj": "string",
    "status": "CRIADA",
    "recebedor": {
      "convenio": "string"
    },
    "paginacao": {
      "paginaAtual": 1,
      "itensPorPagina": 1,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 1
    }
  },
  "cobsr": [
    {
      "txid": "string",
      "idRec": "string",
      "calendario": {
        "criacao": "2026-09-16T19:14:18.843Z",
        "dataDeVencimento": "2026-09-16"
      },
      "valor": {
        "original": "string"
      },
      "ajusteDiaUtil": true,
      "recebedor": {
        "agencia": "string",
        "conta": "string",
        "tipoConta": "CORRENTE",
        "cnpj": "string",
        "nome": "string",
        "convenio": "string"
      },
      "devedor": {
        "cpf": "string",
        "cnpj": "string",
        "nome": "string",
        "email": "string",
        "logradouro": "string",
        "cidade": "string",
        "uf": "string",
        "cep": "string"
      },
      "infoAdicional": "string",
      "politicaRetentativa": "NAO_PERMITE",
      "status": "CRIADA",
      "encerramento": {
        "rejeicao": {
          "codigo": "string",
          "descricao": "string"
        },
        "cancelamento": {
          "solicitante": "PSP_PAGADOR",
          "codigo": "string",
          "descricao": "string"
        }
      },
      "tentativas": [
        {
          "endToEndId": "string",
          "tipo": "AGND",
          "status": "SOLICITADA",
          "dataLiquidacao": "2026-09-16",
          "rejeicao": {
            "codigo": "string",
            "descricao": "string"
          },
          "atualizacao": [
            {
              "status": "string",
              "statusAnterior": "string",
              "origem": "USER",
              "motivo": "string",
              "data": "2026-09-16T19:14:18.843Z"
            }
          ]
        }
      ],
      "atualizacao": [
        {
          "status": "string",
          "statusAnterior": "string",
          "origem": "USER",
          "motivo": "string",
          "data": "2026-09-16T19:14:18.843Z"
        }
      ]
    }
  ]
}

Operação realizada com sucesso