Create a recurrence

​

Creates a rec in status CRIADA.

Headers
  • Idempotency-Key
    Type: string
    required
Body·
required
application/json
  • calendario
    Type: object ·
    required
  • valor
    Type: object ·
    required
  • vinculo
    Type: object ·
    required
  • ativacao
    Type: object ·
  • loc
    Type: string
  • politicaRetentativa
    Type: string enum
    values
    • NAO_PERMITE
    • PERMITE_3R_7D
  • recebedor
    Type: object ·
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 post/api/rec
curl http://localhost:8080/api/rec \
  --request POST \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "vinculo": {
    "contrato": "",
    "devedor": {
      "cpf": "",
      "cnpj": "",
      "nome": ""
    },
    "objeto": ""
  },
  "calendario": {
    "dataInicial": "",
    "dataFinal": "",
    "periodicidade": "SEMANAL"
  },
  "valor": {
    "valorRec": "",
    "valorMinimoRecebedor": ""
  },
  "recebedor": {
    "cnpj": "",
    "nome": "",
    "convenio": ""
  },
  "ativacao": {
    "tipoJornada": "JORNADA_1",
    "dadosJornada": {
      "txid": ""
    }
  },
  "loc": "",
  "politicaRetentativa": "NAO_PERMITE"
}'

{
  "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"
  }
}

Criado com sucesso