--- title: "Revisar recorrência." method: PATCH path: "/rec/{idRec}" tags: ["Rec"] --- # Revisar recorrência. `PATCH /rec/{idRec}` Revisar recorrência. ## Request body - RecRevisada — Atributos de Revisão da Configuração de Recorrência - `status` 'CANCELADA' - `vinculo` object - `devedor` union — O objeto devedor organiza as informações sobre o devedor da recorrência. - object - `nome` string, required — Nome do usuário. - object - `nome` string, required — Nome do usuário. - `loc` integer — Identificador da location a ser informada na criação de uma recorrência . - `calendario` object — Informações sobre calendário da recorrência - `dataInicial` string, date — Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. Data estimada de primeiro pagamento. - `ativacao` object — Dados relacionados à confirmação da ativação da recorrência. - `dadosJornada` object — Dado de preenchimento obrigatório quando utilizada a Jornada 3. Este campo deve ser removido pelo PSP Recebedor quando a ativação for realizada pelas jornadas 1, 2 ou 4. - `txid` string, required — # Identificador da transação O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos. Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`. Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix. ## Response `200` Recorrência revisada. - RecGerada — Atributos de Configuração de Recorrência - `idRec` string, required — # Identificador da Recorrência Regra de formação: - RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo: - "R": fixo (1 caractere). "R" para a recorrência criada dentro do Pix; - "A": identificação da possibilidade de novas tentativas, sendo possí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. - "xxxxxxxx": identificação do agente que presta serviço para o usuário recebedor que gerou o ID Recorrência, podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros caracteres do CNPJ do prestador de serviço de iniciação (8 caracteres alfanuméricos [A-Z|0-9]); - "yyyyMMdd": data (8 caracteres) de criação da recorrência; - "kkkkkkkkkkk": sequencial criado pelo agente que gerou o ID Recorrência (11 caracteres alfanuméricos [a-z|A-Z|0-9]). Deve ser único dentro de cada "yyyyMMdd". Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir: - "RRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou - "RNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.” - `vinculo` object, required — Informações sobre o objeto da recorrência. - `objeto` string — 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. - `devedor` union, required — O objeto devedor organiza as informações sobre o devedor da recorrência. - PessoaFisicaRecorrencia - `cpf` string, required — CPF do usuário. - `nome` string, required — Nome do usuário. - PessoaJuridicaRecorrencia - `cnpj` string, required — CNPJ do usuário. - `nome` string, required — Nome do usuário. - `contrato` string, required — Número, identificador, ou código que representa o objeto da autorização (contrato, pedido etc.). - `calendario` object, required — Informações sobre calendário da recorrência - `dataInicial` string, date, required — Trata-se de uma data, no formato `YYYY-MM-DD`, segundo ISO 8601. Data estimada de primeiro pagamento. - `dataFinal` string, date — 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` 'SEMANAL' | 'MENSAL' | 'TRIMESTRAL' | 'SEMESTRAL' | 'ANUAL', required - `valor` object - `valorRec` string — 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` string — 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. - `recebedor` object, required - `cnpj` string, required — CNPJ do usuário. - `nome` string, required — Nome do usuário. - `convenio` string — Convênio entre usuário e participante recebedor. - `status` 'CRIADA' | 'APROVADA' | 'REJEITADA' | 'EXPIRADA' | 'CANCELADA', required - `loc` PayloadLocationRecCompleta — Identificador da localização do payload completo. - `id` integer, required — Identificador da location a ser informada na criação de uma recorrência . - `location` string, uri, required — Localização do Payload a ser informada na criação da recorrência. - `criacao` string, date-time, required — Data e hora em que a location foi criada. Respeita RFC 3339. - `idRec` string — # Identificador da Recorrência Regra de formação: - RAxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; "case sensitive", isso é, diferencia letras maiúsculas e minúsculas), sendo: - "R": fixo (1 caractere). "R" para a recorrência criada dentro do Pix; - "A": identificação da possibilidade de novas tentativas, sendo possí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. - "xxxxxxxx": identificação do agente que presta serviço para o usuário recebedor que gerou o ID Recorrência, podendo ser: o ISPB do participante direto, o ISPB do participante indireto ou os 8 primeiros caracteres do CNPJ do prestador de serviço de iniciação (8 caracteres alfanuméricos [A-Z|0-9]); - "yyyyMMdd": data (8 caracteres) de criação da recorrência; - "kkkkkkkkkkk": sequencial criado pelo agente que gerou o ID Recorrência (11 caracteres alfanuméricos [a-z|A-Z|0-9]). Deve ser único dentro de cada "yyyyMMdd". Dessa forma, o ID da recorrência deve ser formado de acordo com um dos tipos a seguir: - "RRxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que permite novas tentativas de pagamento pós vencimento; ou - "RNxxxxxxxxyyyyMMddkkkkkkkkkkk"; para recorrência criada dentro do Pix e que não permite novas tentativas de pagamento pós vencimento.” - `atualizacao` object[], required — Histórico das mudanças de status da recorrência. - `status` 'CRIADA' | 'APROVADA' | 'REJEITADA' | 'EXPIRADA' | 'CANCELADA', required — Status da recorrência. - `data` string, date-time, required — Data e hora do registro de status atualizado. Respeita RFC 3339. - `encerramento` union - object - `rejeicao` object — Informações sobre a rejeição da recorrência - `codigo` 'AP13' | 'AP14' | 'AP15', required — Código da rejeição. Corresponde ao código de rejeição presente no catálogo de mensagens. - `descricao` string, required — Descricao da causa da rejeição - object - `cancelamento` object — Informações sobre o cancelamento da recorrência - `solicitante` 'PSP_PAGADOR' | 'USUARIO_PAGADOR' | 'PSP_RECEBEDOR' | 'USUARIO_RECEBEDOR', required - `codigo` 'ACCL' | 'CPCL' | 'DCSD' | 'ERSL' | 'FRUD' | 'PCFD' | 'SLCR' | 'SLDB', required — Código do cancelamento. Corresponde ao código de cancelamento presente no catálogo de mensagens. **IMPORTANTE:** `PCFD` e `ERSL` estão em desuso (deprecated) sem substitutos. - `descricao` string, required — Descricao do cancelamento. - `ativacao` object — Dados relacionados à confirmação da ativação da recorrência. - `tipoJornada` 'JORNADA_1' | 'JORNADA_2' | 'JORNADA_3' | 'JORNADA_4' | 'AGUARDANDO_DEFINICAO', required — Dado relacionado ao caminho percorrido pelo processo de adesão a recorrência pelo usuário pagador, os valores possíveis são: - JORNADA_1: Usuário pagador aceitou a recorrência através de notificação externa ao ecossistema - JORNADA_2: Usuário pagador aceitou a recorrência através de leitura de QR Code de recorrência - JORNADA_3: Usuário pagador iniciou a recorrência através de leitura de QR Code composto e pagamento de cobrança imediata. O uso desta jornada torna obrigatório o preenchimento da informação dadosJornada.txid - JORNADA_4: Usuário pagador escolheu aderir à recorrência através de leitura de QR Code composto relacionado à cobrança com vencimento ou estática relacionada a um contrato vigente - AGUARDANDO_DEFINICAO: Valor inicial posterior a criação e anterior a ativação da recorrência. - `dadosJornada` object — Dado de preenchimento obrigatório quando utilizada a Jornada 3. Este campo deve ser removido pelo PSP Recebedor quando a ativação for realizada pelas jornadas 1, 2 ou 4. - `txid` string, required — # Identificador da transação O campo `txid` determina o identificador da transação. O objetivo desse campo é ser um elemento que possibilite ao PSP do recebedor apresentar ao usuário recebedor a funcionalidade de conciliação de pagamentos. Na pacs.008, é referenciado como `TransactionIdentification ` ou `idConciliacaoRecebedor`. Em termos de fluxo de funcionamento, o txid é lido pelo aplicativo do PSP do pagador e, depois de confirmado o pagamento, é enviado para o SPI via pacs.008. Uma pacs.008 também é enviada ao PSP do recebedor, contendo, além de todas as informações usuais do pagamento, o txid. Ao perceber um recebimento dotado de txid, o PSP do recebedor está apto a se comunicar com o usuário recebedor, informando que um pagamento específico foi liquidado. O txid é criado exclusivamente pelo usuário recebedor e está sob sua responsabilidade. O txid, no contexto de representação de uma cobrança, é único por CPF/CNPJ do usuário recebedor. Cabe ao PSP recebedor validar essa regra na API Pix. ## Other responses - `400` — Requisição com formato inválido. - `403` — Requisição de participante autenticado que viola alguma regra de autorização. - `404` — Recurso solicitado não foi encontrado. - `503` — Serviço não está disponível no momento. Serviço solicitado pode estar em manutenção ou fora da janela de funcionamento. --- [API](https://skmtc.dev/bacen/apis/api-pix.md) · [All operations](https://skmtc.dev/bacen/apis/api-pix/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bacen/api-pix/revisions/5c39d7116745/schema)