List recurrences 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
  • locationPresente
    Type: boolean
  • status
    Type: string enum
    values
    • CRIADA
    • APROVADA
    • REJEITADA
    • EXPIRADA
    • CANCELADA
  • 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/rec
curl 'http://localhost:8080/api/rec?inicio=&fim=' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "parametros": {
    "inicio": "2026-09-16T19:14:18.661Z",
    "fim": "2026-09-16T19:14:18.661Z",
    "cpf": "string",
    "cnpj": "string",
    "locationPresente": true,
    "status": "CRIADA",
    "recebedor": {
      "convenio": "string"
    },
    "paginacao": {
      "paginaAtual": 1,
      "itensPorPagina": 1,
      "quantidadeDePaginas": 1,
      "quantidadeTotalDeItens": 1
    }
  },
  "recs": [
    {
      "idRec": "string",
      "vinculo": {
        "contrato": "string",
        "devedor": {
          "cpf": "string",
          "cnpj": "string",
          "nome": "string"
        },
        "objeto": "string"
      },
      "calendario": {
        "dataInicial": "2026-09-16",
        "dataFinal": "2026-09-16",
        "periodicidade": "SEMANAL"
      },
      "valor": {
        "valorRec": "string",
        "valorMinimoRecebedor": "string"
      },
      "ativacao": {
        "tipoJornada": "JORNADA_1",
        "dadosJornada": {
          "txid": "string"
        }
      },
      "recebedor": {
        "cnpj": "string",
        "nome": "string",
        "convenio": "string"
      },
      "pagador": {
        "cpf": "string",
        "cnpj": "string",
        "ispbParticipante": "string",
        "codMun": "string"
      },
      "politicaRetentativa": "NAO_PERMITE",
      "status": "CRIADA",
      "atualizacao": [
        {
          "status": "string",
          "statusAnterior": "string",
          "origem": "USER",
          "motivo": "string",
          "data": "2026-09-16T19:14:18.661Z"
        }
      ],
      "loc": {
        "id": "string",
        "location": "string",
        "tipoCob": "string",
        "criacao": "2026-09-16T19:14:18.661Z",
        "idRec": "string"
      },
      "encerramento": {
        "rejeicao": {
          "codigo": "string",
          "descricao": "string"
        },
        "cancelamento": {
          "solicitante": "PSP_PAGADOR",
          "codigo": "string",
          "descricao": "string"
        }
      },
      "solicitacao": [
        {
          "idSolicRec": "string",
          "idRec": "string",
          "calendario": {
            "dataExpiracaoSolicitacao": "2026-09-16T19:14:18.661Z"
          },
          "destinatario": {
            "ispbParticipante": "string",
            "conta": "string",
            "agencia": "string",
            "cpf": "string",
            "cnpj": "string"
          },
          "status": "CRIADA",
          "atualizacao": [
            {
              "status": "string",
              "statusAnterior": "string",
              "origem": "USER",
              "motivo": "string",
              "data": "2026-09-16T19:14:18.661Z"
            }
          ],
          "encerramento": {
            "rejeicao": {
              "motivo": "DADOS_BANCARIOS_INVALIDOS"
            }
          },
          "recPayload": {
            "idRec": "string",
            "vinculo": {
              "contrato": "string",
              "devedor": {
                "cpf": "string",
                "cnpj": "string",
                "nome": "string"
              },
              "objeto": "string"
            },
            "calendario": {
              "dataInicial": "2026-09-16",
              "dataFinal": "2026-09-16",
              "periodicidade": "SEMANAL"
            },
            "valor": {
              "valorRec": "string",
              "valorMinimoRecebedor": "string"
            },
            "recebedor": {
              "cnpj": "string",
              "nome": "string",
              "ispbParticipante": "string"
            },
            "politicaRetentativa": "NAO_PERMITE",
            "atualizacao": [
              {
                "status": "string",
                "statusAnterior": "string",
                "origem": "USER",
                "motivo": "string",
                "data": "2026-09-16T19:14:18.661Z"
              }
            ]
          }
        }
      ],
      "dadosQR": {
        "jornada": "JORNADA_1",
        "pixCopiaECola": "string"
      }
    }
  ]
}

Operação realizada com sucesso