Create a recurring charge with a client-provided txid

​
Path Parameters
  • txid
    Type: string
    required
Headers
  • Idempotency-Key
    Type: string
    required
Body·
required
application/json
  • calendario
    Type: object ·
    required

    Calendário da cobrança recorrente

  • idRec
    Type: string
    required
  • valor
    Type: object ·
    required
  • ajusteDiaUtil
    Type: boolean
  • devedor
    Type: object ·

    Devedor da cobrança recorrente

  • infoAdicional
    Type: string
  • politicaRetentativa
    Type: string enum
    values
    • NAO_PERMITE
    • PERMITE_3R_7D
  • recebedor
    Type: object ·

    Recebedor da cobrança recorrente

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)

  • 404

    Recurso não encontrado para esta conta

  • 503

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

Request Example for put/api/cobr/{txid}
curl 'http://localhost:8080/api/cobr/{txid}' \
  --request PUT \
  --header 'Idempotency-Key: ' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --data '{
  "idRec": "",
  "calendario": {
    "criacao": "",
    "dataDeVencimento": ""
  },
  "valor": {
    "original": ""
  },
  "ajusteDiaUtil": true,
  "recebedor": {
    "agencia": "",
    "conta": "",
    "tipoConta": "CORRENTE",
    "cnpj": "",
    "nome": "",
    "convenio": ""
  },
  "devedor": {
    "cpf": "",
    "cnpj": "",
    "nome": "",
    "email": "",
    "logradouro": "",
    "cidade": "",
    "uf": "",
    "cep": ""
  },
  "infoAdicional": "",
  "politicaRetentativa": "NAO_PERMITE"
}'

{
  "txid": "string",
  "idRec": "string",
  "calendario": {
    "criacao": "2026-09-16T19:14:18.660Z",
    "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.660Z"
        }
      ]
    }
  ],
  "atualizacao": [
    {
      "status": "string",
      "statusAnterior": "string",
      "origem": "USER",
      "motivo": "string",
      "data": "2026-09-16T19:14:18.660Z"
    }
  ]
}

Criado com sucesso