--- title: "Criar solicitação de confirmação de recorrência." method: POST path: "/solicrec" tags: ["SolicRec"] --- # Criar solicitação de confirmação de recorrência. `POST /solicrec` Criar solicitação de confirmação de recorrência. ## Request body - SolicRecSolicitada — Dados criados ou alterados da cobrança recorrente via API Pix - `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.” - `calendario` object, required - `dataExpiracaoSolicitacao` string, date-time, required — Data da expiração da solicitação enviada ao usuário pagador. Respeita RFC 3339. - `destinatario` DadosBancarios, required - `conta` string, required — Número da conta do usuário pagador. - `ispbParticipante` string, required — ISPB do usuário pagador. - `agencia` string — Número da agência do usuário pagador. ## Response `201` Solicitação de recorrência criada - SolicRecCompleta — Dados criados ou alterados da cobrança recorrente via API Pix - `idSolicRec` string, required — # Identificador da Solicitação da Recorrência Regra de formação: - SCxxxxxxxxyyyyMMddkkkkkkkkkkk (29 caracteres; “case sensitive”, isso é, diferencia letras maiúsculas e minúsculas), sendo: - SC - fixo (2 caracteres); - xxxxxxxx – ISPB do agente que envia a mensagem pain.009 de solicitação de confirmação da recorrência (8 caracteres alfanuméricos [A-Z|0-9]); - yyyyMMdd – data (8 caracteres) de criação da mensagem pain.009 de solicitação de confirmação da recorrência; - kkkkkkkkkkk – sequencial criado pelo agente que gerou a mensagem 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”. - `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.” - `calendario` object, required - `dataExpiracaoSolicitacao` string, date-time, required — Data da expiração da solicitação enviada ao usuário pagador. Respeita RFC 3339. - `destinatario` DadosBancarios, required - `conta` string, required — Número da conta do usuário pagador. - `ispbParticipante` string, required — ISPB do usuário pagador. - `agencia` string — Número da agência do usuário pagador. - `status` 'CRIADA' | 'ENVIADA' | 'RECEBIDA' | 'REJEITADA' | 'ACEITA' | 'EXPIRADA' | 'CANCELADA', required - `atualizacao` object[], required - `status` 'CRIADA' | 'ENVIADA' | 'RECEBIDA' | 'REJEITADA' | 'ACEITA' | 'EXPIRADA' | 'CANCELADA', required - `data` string, date-time, required — Data e hora do registro de status atualizado. Respeita RFC 3339. - `encerramento` object - `rejeicao` object — Informações sobre a rejeição da solicitação de recorrência - `motivo` 'DADOS_BANCARIOS_INVALIDOS', required — Motivo pelo qual a solicitação de recorrência foi rejeitada. - `recPayload` RecPayload — 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. - `ispbParticipante` string, required — ISPB do usuário recebedor. - `politicaRetentativa` 'NAO_PERMITE' | 'PERMITE_3R_7D', required - `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. ## 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)