Solicitação de Recorrência Completa

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/banco-inter/main/json-schema/banco-inter-solic-rec-completa-schema.json",
  "title": "Solicitação de Recorrência Completa",
  "description": "Dados criados ou alterados da solicitação da recorrência",
  "x-generated": "2026-10-18",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/banco-inter-pix-automatico-openapi.yml#/components/schemas/SolicRecCompleta",
  "type": "object",
  "required": [
    "rec"
  ],
  "allOf": [
    {
      "$ref": "#/$defs/SolicRecBase"
    },
    {
      "$ref": "#/$defs/SolicRecId"
    },
    {
      "$ref": "#/$defs/SolicRecStatus"
    },
    {
      "$ref": "#/$defs/SolicRecAtualizacao"
    },
    {
      "type": "object",
      "properties": {
        "recPayload": {
          "$ref": "#/$defs/RecPayload"
        }
      }
    }
  ],
  "$defs": {
    "CNPJ": {
      "type": "string",
      "title": "CNPJ",
      "pattern": "\\\\d{14}",
      "description": "CNPJ do usuário."
    },
    "CPF": {
      "type": "string",
      "title": "CPF",
      "pattern": "\\\\d{11}",
      "description": "CPF do usuário."
    },
    "DadosBancarios": {
      "type": "object",
      "description": "Contendo `conta`, `ìspbParticipante`, `agencia`  e `cpf` ou `cnpj` do pagador.",
      "required": [
        "conta",
        "ispbParticipante",
        "cpf",
        "cnpj"
      ],
      "properties": {
        "conta": {
          "type": "string",
          "title": "Conta do Usuário Pagador",
          "description": "Número da conta do usuário pagador.",
          "maxLength": 20
        },
        "ispbParticipante": {
          "type": "string",
          "title": "ISPB do usuário pagador.",
          "description": "ISPB do usuário pagador.",
          "pattern": "\\d{8}"
        },
        "agencia": {
          "type": "string",
          "title": "Agência do Usuário Pagador",
          "description": "Número da agência do usuário pagador.",
          "maxLength": 4
        }
      },
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "cpf": {
              "$ref": "#/$defs/CPF"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "cnpj": {
              "$ref": "#/$defs/CNPJ"
            }
          }
        }
      ]
    },
    "RecAtualizacao": {
      "type": "object",
      "title": "Histórico de atualização da recorrência.",
      "required": [
        "atualizacao"
      ],
      "properties": {
        "atualizacao": {
          "type": "array",
          "title": "Histórico de Status",
          "description": "Contendo `status`e `data`.",
          "items": {
            "type": "object",
            "required": [
              "status",
              "data"
            ],
            "properties": {
              "status": {
                "type": "string",
                "title": "Status da recorrência",
                "description": "Status da recorrência:\n- `CRIADA`: Recorrência criada, aguardando aprovação do pagador\n- `APROVADA`: Recorrência aprovada pelo pagador e ativa\n- `REJEITADA`: Recorrência rejeitada pelo pagador\n- `EXPIRADA`: Recorrência expirou sem aprovação\n- `CANCELADA`: Recorrência cancelada pelo recebedor ou pagador\n",
                "enum": [
                  "CRIADA",
                  "APROVADA",
                  "REJEITADA",
                  "EXPIRADA",
                  "CANCELADA"
                ]
              },
              "data": {
                "type": "string",
                "format": "date-time",
                "description": "Data e hora do registro de status atualizado. Respeita RFC 3339."
              }
            }
          }
        }
      }
    },
    "RecBase": {
      "title": "Recorrência Base",
      "type": "object",
      "required": [
        "calendario",
        "vinculo"
      ],
      "description": "Atributos de Configuração de Recorrência",
      "properties": {
        "vinculo": {
          "$ref": "#/$defs/RecBaseObjeto"
        },
        "calendario": {
          "$ref": "#/$defs/RecBaseCalendario"
        },
        "valor": {
          "type": "object",
          "description": "Contendo `valorRec`e `ValorMinimoRecebedor`",
          "properties": {
            "valorRec": {
              "type": "string",
              "pattern": "\\d{1,10}\\.\\d{2}",
              "title": "Valor da recorrência",
              "description": "Campo opcional, deve ser preenchido apenas quando o valor dos pagamentos for fixo ou não for sujeito a alteração durante a vigência da autorização."
            },
            "valorMinimoRecebedor": {
              "type": "string",
              "pattern": "\\d{1,10}\\.\\d{2}",
              "title": "Valor mínimo da recorrência",
              "description": "Campo opcional. Valor definido pelo usuário recebedor. Se o usuário pagador atribuir um valor máximo para os pagamentos daquela autorização, ele não poderá ser inferior ao piso definido pelo usuário recebedor. Não pode ser preenchido nas autorizações de valor fixo, ou seja, com campo valor preenchido."
            }
          }
        }
      }
    },
    "RecBaseCalendario": {
      "type": "object",
      "title": "Informações sobre calendário da recorrência",
      "description": "Contendo `dataInicial`, `dataFinal` e `periodicidade` da recorrência.",
      "required": [
        "dataInicial",
        "periodicidade"
      ],
      "properties": {
        "dataInicial": {
          "type": "string",
          "format": "date",
          "x-future-or-present": true,
          "title": "Data estimada de primeiro pagamento.",
          "description": "Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. Data estimada de primeiro pagamento."
        },
        "dataFinal": {
          "type": "string",
          "format": "date",
          "x-future-or-present": true,
          "title": "Data final da vigência.",
          "description": "Campo opcional que deve ser preenchido para autorizações com vigência pré-definida, devendo ser compatível com os valores informados em tipoFrequencia e a dataInicialRecorrencia. Não deve ser preenchido para autorizações por tempo indeterminado. Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601."
        },
        "periodicidade": {
          "type": "string",
          "title": "Periodicidade das cobranças recorrentes.",
          "enum": [
            "SEMANAL",
            "MENSAL",
            "TRIMESTRAL",
            "SEMESTRAL",
            "ANUAL"
          ]
        }
      }
    },
    "RecBaseObjeto": {
      "type": "object",
      "title": "Descrição do Objeto da Recorrência",
      "required": [
        "contrato",
        "devedor"
      ],
      "description": "Contendo `objeto`, `devedor` e `contrato`.",
      "properties": {
        "objeto": {
          "type": "string",
          "title": "Identificador do objeto de vínculo",
          "description": "Campo de texto livre para informações referentes ao contrato que permitam ao usuário pagador reconhecer o objeto dos pagamentos periódicos por meio do Pix Automático.",
          "maxLength": 35
        },
        "devedor": {
          "title": "Informações sobre o devedor da recorrência",
          "description": "Contendo `nome` e `cpf` ou `cnpj`",
          "required": [
            "nome",
            "cpf",
            "cnpj"
          ],
          "oneOf": [
            {
              "type": "object",
              "title": "nome e CPF",
              "properties": {
                "nome": {
                  "type": "string",
                  "title": "Nome",
                  "description": "Nome do devedor.",
                  "maxLength": 140
                },
                "cpf": {
                  "type": "string",
                  "title": "CPF",
                  "pattern": "\\d{11}",
                  "description": "CPF do devedor."
                }
              }
            },
            {
              "type": "object",
              "title": "nome e CNPJ",
              "properties": {
                "nome": {
                  "type": "string",
                  "title": "Nome",
                  "description": "Nome do devedor.",
                  "maxLength": 140
                },
                "cnpj": {
                  "type": "string",
                  "title": "CNPJ",
                  "pattern": "\\d{14}",
                  "description": "CNPJ do devedor."
                }
              }
            }
          ]
        },
        "contrato": {
          "type": "string",
          "title": "Objeto da autorização",
          "description": "Número, identificador, ou código que representa o objeto da autorização (contrato, pedido etc.).",
          "maxLength": 35
        }
      }
    },
    "RecConfiguracao": {
      "type": "object",
      "title": "Configuração da Recorrência",
      "required": [
        "politicaRetentativa"
      ],
      "properties": {
        "politicaRetentativa": {
          "type": "string",
          "title": "Política de retentativa pós vencimento da recorrência",
          "description": "NAO_PERMITE: Não permite retentativas.</br> PERMITE_3R_7D: Permite até 3 retentativas em dias diferentes no intervalo de até 7 dias corridos contados a partir da data de liquidação prevista na instrução de pagamento original.</br> As retentativas devem ser enviadas pelo recebedor. [Consulte a documentação](#tag/Cobranca-Recorrente/operation/cobrTxidRetentativaDataPost)",
          "enum": [
            "NAO_PERMITE",
            "PERMITE_3R_7D"
          ]
        }
      }
    },
    "RecId": {
      "type": "string",
      "title": "ID Recorrência",
      "description": "# Identificador da Recorrência\n\nRegra de formação:\n\n  - RAxxxxxxxxyyyyMMddzzzzzzzzzzz (29 caracteres; \"case sensitive\", isso\né, diferencia letras maiúsculas e minúsculas), sendo:\n  - \"R\":  fixo (1 caractere). \"R\" para a recorrência criada dentro do\nPix;\n  - \"A\": identificação da possibilidade de novas tentativas, sendo\npossíveis os valores \"R\" ou \"N\" (1 caractere). \"R\" caso a recorrência permita novas tentativas de pagamento pós vencimento, ou \"N\" caso não permita novas tentativas.\n  - \"xxxxxxxx\":  identificação do agente que presta serviço para o\nusuário recebedor que gerou o <Id>, podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros dígitos do CNPJ do prestador de serviço de iniciação (8 caracteres numéricos [0-9]);\n  - \"yyyyMMdd\":  data (8 caracteres) de criação da recorrência;\n  - \"zzzzzzzzzzz\": sequencial criado pelo agente que gerou o <Id>\n(11 caracteres alfanuméricos [a-z|A-Z|0-9]). Deve ser único dentro de cada \"yyyyMMdd\".\nDessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir:\n- \"RRxxxxxxxxyyyyMMddzzzzzzzzzzz\"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou\n- \"RNxxxxxxxxyyyyMMddzzzzzzzzzzz\"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.\n",
      "pattern": "[a-zA-Z0-9]{29}",
      "minLength": 29,
      "maxLength": 29
    },
    "RecPayload": {
      "type": "object",
      "title": "Payload da Recorrência",
      "required": [
        "idRec",
        "atualizacao",
        "recebedor"
      ],
      "description": "Atributos de Configuração de Recorrência:\n\n`vinculo`, `calendario`, `valor`, `idRec`, `recebedor`, `politicaRetentativa` e `atualizacao`",
      "allOf": [
        {
          "$ref": "#/$defs/RecBase"
        },
        {
          "type": "object",
          "properties": {
            "idRec": {
              "$ref": "#/$defs/RecId"
            }
          }
        },
        {
          "type": "object",
          "properties": {
            "recebedor": {
              "type": "object",
              "required": [
                "nome",
                "cnpj",
                "ispbParticipante"
              ],
              "title": "Recebedor",
              "description": "Dados do recebedor `cnpj`, `nome` e `ispbParticipante`",
              "properties": {
                "cnpj": {
                  "type": "string",
                  "title": "CNPJ",
                  "pattern": "\\d{14}",
                  "description": "CNPJ do usuário."
                },
                "nome": {
                  "type": "string",
                  "title": "Nome",
                  "description": "Nome do usuário.",
                  "maxLength": 140
                },
                "ispbParticipante": {
                  "type": "string",
                  "title": "ISPB do usuário recebedor.",
                  "description": "ISPB do usuário recebedor.",
                  "pattern": "\\d{8}"
                }
              }
            }
          }
        },
        {
          "$ref": "#/$defs/RecConfiguracao"
        },
        {
          "$ref": "#/$defs/RecAtualizacao"
        }
      ]
    },
    "SolicRecAtualizacao": {
      "type": "object",
      "title": "Histórico de Status da Solicitação de Recorrência",
      "required": [
        "atualizacao"
      ],
      "properties": {
        "atualizacao": {
          "type": "array",
          "title": "Histórico de Status da Solicitação de Recorrência",
          "description": "Contendo `status`e `data`",
          "items": {
            "type": "object",
            "required": [
              "status",
              "data"
            ],
            "properties": {
              "status": {
                "type": "string",
                "title": "Status do registro da solicitação de recorrência",
                "description": "Status da solicitação de recorrência:\n- `CRIADA`: Solicitação criada, aguardando envio\n- `ENVIADA`: Solicitação enviada ao pagador\n- `RECEBIDA`: Solicitação recebida pelo pagador\n- `REJEITADA`: Solicitação rejeitada pelo pagador\n- `ACEITA`: Solicitação aceita pelo pagador\n- `EXPIRADA`: Solicitação expirou sem resposta\n- `CANCELADA`: Solicitação cancelada\n",
                "enum": [
                  "CRIADA",
                  "ENVIADA",
                  "RECEBIDA",
                  "REJEITADA",
                  "ACEITA",
                  "EXPIRADA",
                  "CANCELADA"
                ]
              },
              "data": {
                "type": "string",
                "format": "date-time",
                "description": "Data e hora do registro de status atualizado. Respeita RFC 3339."
              }
            }
          }
        }
      }
    },
    "SolicRecBase": {
      "type": "object",
      "title": "Solicitação de Recorrência Base",
      "required": [
        "calendario",
        "idRec",
        "destinatario"
      ],
      "description": "Dados criados ou alterados da cobrança recorrente via API Pix",
      "properties": {
        "idRec": {
          "$ref": "#/$defs/RecId"
        },
        "calendario": {
          "$ref": "#/$defs/SolicrecBaseCalendario"
        },
        "destinatario": {
          "$ref": "#/$defs/DadosBancarios"
        }
      }
    },
    "SolicRecId": {
      "type": "object",
      "title": "Id da Solicitação de recorrência",
      "required": [
        "idSolicRec"
      ],
      "description": "Dados criados ou alterados da cobrança recorrente via API Pix",
      "properties": {
        "idSolicRec": {
          "type": "string",
          "title": "ID Solicitação da Recorrência",
          "description": "# Identificador da Solicitação da Recorrência\n\nRegra de formação:\n- SCxxxxxxxxyyyyMMddzzzzzzzzzzz (29 caracteres; “case sensitive”, isso é, diferencia letras maiúsculas e minúsculas), sendo:\n  - SC - fixo (2 caracteres);\n  - xxxxxxxx – ISPB do agente que envia a mensagem pain.009 de\nsolicitação de confirmação da recorrência;\n  - yyyyMMdd – data (8 caracteres) de criação da mensagem pain.009\nde solicitação de confirmação da recorrência;\n  - zzzzzzzzzzz – sequencial criado pelo agente que gerou a\nmensagem de solicitação de confirmação da recorrência (11 caracteres alfanuméricos [a-z|A-Z|0-9]). Deve ser único dentro de cada “yyyyMMdd”.\n",
          "pattern": "[a-zA-Z0-9]{29}",
          "minLength": 29,
          "maxLength": 29
        }
      }
    },
    "SolicRecStatus": {
      "type": "object",
      "title": "Status da Solicitação de Recorrência",
      "required": [
        "status"
      ],
      "properties": {
        "status": {
          "type": "string",
          "title": "Status do registro da solicitação de recorrência",
          "description": "Status da solicitação de recorrência:\n- `CRIADA`: Solicitação criada, aguardando envio\n- `ENVIADA`: Solicitação enviada ao pagador\n- `RECEBIDA`: Solicitação recebida pelo pagador\n- `REJEITADA`: Solicitação rejeitada pelo pagador\n- `ACEITA`: Solicitação aceita pelo pagador\n- `EXPIRADA`: Solicitação expirou sem resposta\n- `CANCELADA`: Solicitação cancelada\n",
          "enum": [
            "CRIADA",
            "ENVIADA",
            "RECEBIDA",
            "REJEITADA",
            "ACEITA",
            "EXPIRADA",
            "CANCELADA"
          ]
        }
      }
    },
    "SolicrecBaseCalendario": {
      "type": "object",
      "title": "Informações de calendário da solicitação da recorrência",
      "description": "Contendo `dataExpiracaoSolicitacao` da solicitação de recorrência.",
      "required": [
        "dataExpiracaoSolicitacao"
      ],
      "properties": {
        "dataExpiracaoSolicitacao": {
          "type": "string",
          "format": "date-time",
          "title": "Data de expiração da solicitação",
          "description": "Data de expiração da solicitação de recorrência. Respeita RFC 3339."
        }
      }
    }
  }
}