Changelog - [SV] Pagamentos Automáticos - v2.2.0-rc.2 - v2.2.0-rc.1

/info

Alterado - "description"

Alteração

API de Iniciação de Pagamentos automáticos, responsável por viabilizar as operações de iniciação de pagamentos automáticos (Pix automático e Transferências Inteligentes) para o Open Finance Brasil.
Para cada uma das formas de pagamento previstas é necessário obter prévio consentimento do cliente através dos endpoints dedicados ao consentimento nesta API.

# Orientações

• `CONTA`, referente ás instituições detentoras de conta participantes do Open Finance Brasil;

• `PAGTO`, referente ás instituições iniciadoras de pagamento participantes do Open Finance Brasil….
  
  

API de Iniciação de Pagamentos automáticos, responsável por viabilizar as operações de iniciação de pagamentos automáticos (Pix automático e Transferências Inteligentes) para o Open Finance Brasil.
Para cada uma das formas de pagamento previstas é necessário obter prévio consentimento do cliente através dos endpoints dedicados ao consentimento nesta API.

# Orientações

• `CONTA`, referente ás instituições detentoras de conta participantes do Open Finance Brasil;

• `PAGTO`, referente ás instituições iniciadoras de pagamento participantes do Open Finance Brasil…
  
  

/info

Alterado - "version"

Alteração

2.2.0-rc.1

2.2.0-rc.2

get/responses/200/data/items/paymentReference

Alterado - "example"

Alteração

23-07-2025/P1W

R/2025-09-23/P1M

get/responses/200/data/items/paymentReference

Removido - "minLength"

Remoção

4

get/responses/200/data/items/paymentReference

Removido - "maxLength"

Remoção

14

get/responses/200/data/items/paymentReference

Removido - "pattern"

Remoção

^zero$|^\d{2}-\d{2}-\d{4}\/P(1W|1M|3M|6M|1Y)$

get/responses/200/data/items/paymentReference

Alterado - "description"

Alteração

[Restrição]Campo de preenchimento obrigatório caso seja um pagamento de Pix automático e deve ser enviado para critérios de coleta de métricas do ecossistema. Caso essa regra não seja respeitada, a instituição detentora da conta deve retornar um erro HTTP 422 com o código DETALHE_PAGAMENTO_INVALIDO. 

• O preenchimento deve seguir a seguinte lógica: 

• Primeiro Pagamento: Caso se trate do pagamento inicial avulso, especificado no campo "/data/firstPayment", o valor deste campo deve ser preenchido com a string fixa "zero". 

• Pagamentos Recorrentes (Subsequentes): Para todos os pagamentos recorrentes realizados após o pagamento inicial, o campo paymentReference deve ser preenchido com uma string de Intervalo ISO 8601 no formato ```<start>/<duration>```, que representa o ciclo exato ao qual o pagamento se refere. 

• O componente ```<start>``` deve indicar a data de iní­cio do ciclo especí­fico ao qual o pagamento enviado se refere. 

• O componente ```<duration>``` deve corresponder ao código da periodicidade do consentimento (P1W para semanal, P1M para mensal, P3M para trimestral, P6M para semestral e P1Y para anual) 

• Exemplos:

• 1: Data de iní­cio do ciclo definido no consentimento: 23/07/25

• Periodicidade definida no consentimento: Semanal

• Preenchimento do paymentReference:

• Primeiro ciclo: 23-07-2025/P1W

• Segundo ciclo: 30-07-2025/P1W

• Terceiro ciclo: 06-07-2025/P1W

• 2: Data de iní­cio do ciclo definido no consentimento: 23/07/25

• Periodicidade definida no consentimento: Mensal

• Preenchimento do paymentReference:

• Primeiro ciclo: 23-07-2025/P1M

• Segundo ciclo: 23-08-2025/P1M

• Terceiro ciclo: 23-09-2025/P1M

[Restrição] Campo de preenchimento obrigatório caso seja um pagamento de Pix automático e deve ser enviado para critérios de coleta de métricas do ecossistema. Caso essa regra não seja respeitada, a instituição detentora da conta deve retornar um erro HTTP 422 com o código DETALHE_PAGAMENTO_INVALIDO. 
O preenchimento deve seguir a seguinte lógica: 

• Primeiro Pagamento: Se for o pagamento inicial especificado no campo /data/firstPayment, preencha o campo com a string fixa "zero". 

• Pagamentos Recorrentes (Subsequentes): Para todos os pagamentos recorrentes após o inicial, o campo paymentReference deve ser preenchido com uma string ISO 8601 no formato ```R/<start>/<duration>```, representando o ciclo exato que está sendo pago. 

• ```R```, seguindo o padrão ISO8601 para representar a recorrência única do ciclo que se iniciou no dia informado no componente ```<start>```. 

• O componente ```<start>``` deve ser a data de iní­cio do ciclo especí­fico, no formato ```YYYY-MM-DD```, ao qual o pagamento sendo enviado se refere.   

• O componente ```<duration>``` representa o intervalo de ciclos definido para o consentimento autorizado (P1W para semanal, P1M para mensal, P3M para trimestral, P6M para semestral e P1Y para anual).  

• Exemplos:

• 1: Data de iní­cio do ciclo definido no consentimento: 23/07/25

• Periodicidade definida no consentimento: Semanal

• Preenchimento do paymentReference:

• Primeiro ciclo: R/2025-07-23/P1W

• Segundo ciclo:  R/2025-07-30/P1W

• Terceiro ciclo: R/2025-08-06/P1W

• 2: Data de iní­cio do ciclo definido no consentimento: 23/07/25

• Periodicidade definida no consentimento: Mensal

• Preenchimento do paymentReference:

• Primeiro ciclo: R/2025-07-23/P1M

• Segundo ciclo: R/2025-08-23/P1M

• Terceiro ciclo: R/2025-09-23/P1M

get/responses/200/data/items/rejectionReason/code

Alterado - "description"

Alteração

Código identificador do motivo de rejeição.
Motivo da rejeição do pagamento. Informaçíµes complementares sobre o motivo do status.

• SALDO_INSUFICIENTE

• VALOR_ACIMA_LIMITE

• VALOR_INVALIDO

• NAO_INFORMADO

• PAGAMENTO_DIVERGENTE_CONSENTIMENTO

• PAGAMENTO_RECUSADO_DETENTORA

• PAGAMENTO_RECUSADO_SPI

• CONSENTIMENTO_INVALIDO

• FALHA_INFRAESTRUTURA_SPI

• FALHA_INFRAESTRUTURA_ICP

• FALHA_INFRAESTRUTURA_PSP_RECEBEDOR

• FALHA_INFRAESTRUTURA_DETENTORA

• LIMITE_PERIODO_VALOR_EXCEDIDO

• LIMITE_PERIODO_QUANTIDADE_EXCEDIDO

• TITULARIDADE_INCONSISTENTE

• LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO

• LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO: O valor da transação ultrapassar o limite de valor por transação

• CONSENTIMENTO_REVOGADO

• LIMITE_TENTATIVAS_EXCEDIDO

• FORA_PRAZO_PERMITIDO

• DETALHE_TENTATIVA_INVALIDO

• DETALHE_PAGAMENTO_INVALIDO

[Restrição] Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED).

Código identificador do motivo de rejeição.
Motivo da rejeição do pagamento. Informaçíµes complementares sobre o motivo do status.

• SALDO_INSUFICIENTE

• VALOR_ACIMA_LIMITE

• VALOR_INVALIDO

• NAO_INFORMADO

• PAGAMENTO_DIVERGENTE_CONSENTIMENTO

• PAGAMENTO_RECUSADO_DETENTORA

• PAGAMENTO_RECUSADO_SPI

• CONSENTIMENTO_INVALIDO

• FALHA_INFRAESTRUTURA_SPI

• FALHA_INFRAESTRUTURA_ICP

• FALHA_INFRAESTRUTURA_PSP_RECEBEDOR

• FALHA_INFRAESTRUTURA_DETENTORA

• LIMITE_PERIODO_VALOR_EXCEDIDO

• LIMITE_PERIODO_QUANTIDADE_EXCEDIDO

• TITULARIDADE_INCONSISTENTE

• LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO

• LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO: O valor da transação ultrapassar o limite de valor por transação

• LIMITE_TENTATIVAS_EXCEDIDO

• FORA_PRAZO_PERMITIDO

• DETALHE_TENTATIVA_INVALIDO

• DETALHE_PAGAMENTO_INVALIDO

[Restrição] Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED).

get/responses/200/data/items/rejectionReason/code/enum

Removido - "CONSENTIMENTO_REVOGADO"

Remoção

enum

get/responses/200/data/items/rejectionReason/detail

Alterado - "description"

Alteração

Detalhe sobre o código identificador do motivo de rejeição.

• SALDO_INSUFICIENTE: A conta selecionada não possui saldo suficiente para realizar o pagamento;

• VALOR_ACIMA_LIMITE: Valida se o valor ultrapassa o limite estabelecido [na instituição (conta ou canal)/no arranjo] para permitir a realização de transaçíµes pelo cliente;

• VALOR_INVALIDO: O valor enviado não é válido;

• NAO_INFORMADO: Não reportado/identificado pela instituição detentora de conta;

• PAGAMENTO_DIVERGENTE_CONSENTIMENTO: Dados do pagamento divergentes dos dados do consentimento;

• PAGAMENTO_RECUSADO_DETENTORA: [descrição do motivo de recusa];

• PAGAMENTO_RECUSADO_SPI: [código de erro conforme tabela de domí­nios reason PACS.002];

• CONSENTIMENTO_INVALIDO: Consentimento inválido (em status final);

• FALHA_INFRAESTRUTURA_SPI: Indica uma falha no Sistema de Pagamentos Instantâneos (SPI);

• FALHA_INFRAESTRUTURA_ICP: Indica uma falha na Infraestrutura de Chaves Públicas (ICP);

• FALHA_INFRAESTRUTURA_PSP_RECEBEDOR: Indica uma falha na infraestrutura do Prestador de Serviço de Pagamento (PSP) que recebe o pagamento;

• FALHA_INFRAESTRUTURA_DETENTORA: indica uma falha na infraestrutura da instituição detentora das informaçíµes ou recursos;

• LIMITE_PERIODO_VALOR_EXCEDIDO: A transação não pode ser realizada pois o valor parametrizado no consentimento foi excedido.

• LIMITE_PERIODO_QUANTIDADE_EXCEDIDO: A transação não pode ser realizada pois a quantidade parametrizada no consentimento foi excedida.

• TITULARIDADE_INCONSISTENTE: Conta atualmente não associada ao CPF/CNPJ do consentimento de longa duração.

• LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO: O valor da transação excede o limite global do consentimento.

• LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO: O valor da transação ultrapassar o limite de valor por transação.

• CONSENTIMENTO_REVOGADO: O pagamento estava associado a um consentimento que foi revogado.

• LIMITE_TENTATIVAS_EXCEDIDO: O máximo de tentativas de liquidação permitidas pelo arranjo foi atingido

• FORA_PRAZO_PERMITIDO: O horário ou perí­odo da requisição não permite o agendamento pelo detentor.

• DETALHE_TENTATIVA_INVALIDO: O parâmetro [nome_do(s)_campo(s)] inseridos para a nova tentativa de pagamento não condizem com o pagamento original que falhou e não são permitidos na nova tentativa de pagamento.

• DETALHE_PAGAMENTO_INVALIDO: Valida se determinado parâmetro informado obedece as regras de negócio

Detalhe sobre o código identificador do motivo de rejeição.

• SALDO_INSUFICIENTE: A conta selecionada não possui saldo suficiente para realizar o pagamento;

• VALOR_ACIMA_LIMITE: Valida se o valor ultrapassa o limite estabelecido [na instituição (conta ou canal)/no arranjo] para permitir a realização de transaçíµes pelo cliente;

• VALOR_INVALIDO: O valor enviado não é válido para o consentimento associado ao pagamento;

• NAO_INFORMADO: Não reportado/identificado pela instituição detentora de conta;

• PAGAMENTO_DIVERGENTE_CONSENTIMENTO: Dados do pagamento divergentes dos dados do consentimento;

• PAGAMENTO_RECUSADO_DETENTORA: [descrição do motivo de recusa];

• PAGAMENTO_RECUSADO_SPI: [código de erro conforme tabela de domí­nios reason PACS.002];

• CONSENTIMENTO_INVALIDO: Consentimento inválido (em status final);

• FALHA_INFRAESTRUTURA_SPI: Indica uma falha no Sistema de Pagamentos Instantâneos (SPI);

• FALHA_INFRAESTRUTURA_ICP: Indica uma falha na Infraestrutura de Chaves Públicas (ICP);

• FALHA_INFRAESTRUTURA_PSP_RECEBEDOR: Indica uma falha na infraestrutura do Prestador de Serviço de Pagamento (PSP) que recebe o pagamento;

• FALHA_INFRAESTRUTURA_DETENTORA: indica uma falha na infraestrutura da instituição detentora das informaçíµes ou recursos;

• LIMITE_PERIODO_VALOR_EXCEDIDO "“ A transação não pode ser realizada pois o valor parametrizado no consentimento foi excedido.

• LIMITE_PERIODO_QUANTIDADE_EXCEDIDO "“ A transação não pode ser realizada pois a quantidade parametrizada no consentimento foi excedida.

• TITULARIDADE_INCONSISTENTE: Conta atualmente não associada ao CPF/CNPJ do consentimento de longa duração.

• LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO: O valor da transação excede o limite global do consentimento.

• LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO: O valor da transação ultrapassar o limite de valor por transação.

• LIMITE_TENTATIVAS_EXCEDIDO: O máximo de tentativas de liquidação permitidas pelo arranjo foi atingido

• FORA_PRAZO_PERMITIDO: O horário ou perí­odo da requisição não permite o agendamento pelo detentor.

• DETALHE_TENTATIVA_INVALIDO: O parâmetro [nome_do(s)_campo(s)] inseridos para a nova tentativa de pagamento não condizem com o pagamento original que falhou e não são permitidos na nova tentativa de pagamento.

• DETALHE_PAGAMENTO_INVALIDO: Valida se determinado parâmetro informado obedece as regras de negócio

post/requestBody/data/properties

Removido - "originalRecurringPaymentId"

Remoção

post/requestBody/data/localInstrument

Alterado - "description"

Alteração

Especifica a forma de iniciação do pagamento

• MANU - Inserção manual de dados da conta transacional

• DICT - Inserção manual de chave Pix

• INIC - Indica que o recebedor (creditor) contratou o Iniciador de Pagamentos especificamente para realizar iniciações de pagamento em que o beneficiário é previamente conhecido

• AUTO - Indica o pagamento de uma recorrência de Pix automático, onde o consentimento foi previamente autorizado pelo pagador e o pagamento é realizado automaticamente pelo Iniciador de Pagamentos sob comando do recebedor.

[Restrição] 
Caso consentimento associado a tentativa de pagamento seja para Pix automático (objeto "automatic" selecionado no oneOf do campo "/data/recurringConfiguration") e a referência do pagamento indicar uma recorrência (valor do campo "/data/paymentReferente" diferente de "zero"), apenas o método AUTO é permitido, ou;
Caso consentimento associado a tentativa de pagamento seja para Pix automático (objeto "automatic" selecionado no oneOf do campo "/data/recurringConfiguration") e a referência do pagamento indicar o pagamento inicial avulso (valor do campo "/data/paymentReferente" igual a "zero"), apenas o método MANU é permitido.

Especifica a forma de iniciação do pagamento

• MANU - Inserção manual de dados da conta transacional

• DICT - Inserção manual de chave Pix

• INIC - Indica que o recebedor (creditor) contratou o Iniciador de Pagamentos especificamente para realizar iniciações de pagamento em que o beneficiário é previamente conhecido

• AUTO - Indica o pagamento de uma recorrência de Pix automático, onde o consentimento foi previamente autorizado pelo pagador e o pagamento é realizado automaticamente pelo Iniciador de Pagamentos sob comando do recebedor.

[Restrição] 
Caso consentimento associado a tentativa de pagamento seja para Pix automático (objeto "automatic" selecionado no oneOf do campo "/data/recurringConfiguration") e a referência do pagamento indicar uma recorrência (valor do campo "/data/paymentReference" diferente de "zero"), apenas o método AUTO é permitido, ou; 
Caso consentimento associado a tentativa de pagamento seja para Pix automático (objeto "automatic" selecionado no oneOf do campo "/data/recurringConfiguration") e a referência do pagamento indicar o pagamento inicial avulso (valor do campo "/data/paymentReference" igual a "zero"), apenas o método MANU é permitido. 
Para consentimentos de Transferências Inteligentes (objeto "sweeping" selecionado no "oneOf" do campo "/data/recurringConfiguration/"), apenas os métodos MANU, DICT e INIC são permitidos.

post/requestBody/data/paymentReference

Alterado - "example"

Alteração

23-07-2025/P1W

R/2025-09-23/P1M

post/requestBody/data/paymentReference

Removido - "minLength"

Remoção

4

post/requestBody/data/paymentReference

Removido - "maxLength"

Remoção

14

post/requestBody/data/paymentReference

Removido - "pattern"

Remoção

^zero$|^\d{2}-\d{2}-\d{4}\/P(1W|1M|3M|6M|1Y)$

post/requestBody/data/paymentReference

Alterado - "description"

Alteração

[Restrição]Campo de preenchimento obrigatório caso seja um pagamento de Pix automático e deve ser enviado para critérios de coleta de métricas do ecossistema. Caso essa regra não seja respeitada, a instituição detentora da conta deve retornar um erro HTTP 422 com o código DETALHE_PAGAMENTO_INVALIDO. 

• O preenchimento deve seguir a seguinte lógica: 

• Primeiro Pagamento: Caso se trate do pagamento inicial avulso, especificado no campo "/data/firstPayment", o valor deste campo deve ser preenchido com a string fixa "zero". 

• Pagamentos Recorrentes (Subsequentes): Para todos os pagamentos recorrentes realizados após o pagamento inicial, o campo paymentReference deve ser preenchido com uma string de Intervalo ISO 8601 no formato ```<start>/<duration>```, que representa o ciclo exato ao qual o pagamento se refere. 

• O componente ```<start>``` deve indicar a data de iní­cio do ciclo especí­fico ao qual o pagamento enviado se refere. 

• O componente ```<duration>``` deve corresponder ao código da periodicidade do consentimento (P1W para semanal, P1M para mensal, P3M para trimestral, P6M para semestral e P1Y para anual) 

• Exemplos:

• 1: Data de iní­cio do ciclo definido no consentimento: 23/07/25

• Periodicidade definida no consentimento: Semanal

• Preenchimento do paymentReference:

• Primeiro ciclo: 23-07-2025/P1W

• Segundo ciclo: 30-07-2025/P1W

• Terceiro ciclo: 06-07-2025/P1W

• 2: Data de iní­cio do ciclo definido no consentimento: 23/07/25

• Periodicidade definida no consentimento: Mensal

• Preenchimento do paymentReference:

• Primeiro ciclo: 23-07-2025/P1M

• Segundo ciclo: 23-08-2025/P1M

• Terceiro ciclo: 23-09-2025/P1M

[Restrição] Campo de preenchimento obrigatório caso seja um pagamento de Pix automático e deve ser enviado para critérios de coleta de métricas do ecossistema. Caso essa regra não seja respeitada, a instituição detentora da conta deve retornar um erro HTTP 422 com o código DETALHE_PAGAMENTO_INVALIDO. 
O preenchimento deve seguir a seguinte lógica: 

• Primeiro Pagamento: Se for o pagamento inicial especificado no campo /data/firstPayment, preencha o campo com a string fixa "zero". 

• Pagamentos Recorrentes (Subsequentes): Para todos os pagamentos recorrentes após o inicial, o campo paymentReference deve ser preenchido com uma string ISO 8601 no formato ```R/<start>/<duration>```, representando o ciclo exato que está sendo pago. 

• ```R```, seguindo o padrão ISO8601 para representar a recorrência única do ciclo que se iniciou no dia informado no componente ```<start>```. 

• O componente ```<start>``` deve ser a data de iní­cio do ciclo especí­fico, no formato ```YYYY-MM-DD```, ao qual o pagamento sendo enviado se refere.   

• O componente ```<duration>``` representa o intervalo de ciclos definido para o consentimento autorizado (P1W para semanal, P1M para mensal, P3M para trimestral, P6M para semestral e P1Y para anual).  

• Exemplos:

• 1: Data de iní­cio do ciclo definido no consentimento: 23/07/25

• Periodicidade definida no consentimento: Semanal

• Preenchimento do paymentReference:

• Primeiro ciclo: R/2025-07-23/P1W

• Segundo ciclo:  R/2025-07-30/P1W

• Terceiro ciclo: R/2025-08-06/P1W

• 2: Data de iní­cio do ciclo definido no consentimento: 23/07/25

• Periodicidade definida no consentimento: Mensal

• Preenchimento do paymentReference:

• Primeiro ciclo: R/2025-07-23/P1M

• Segundo ciclo: R/2025-08-23/P1M

• Terceiro ciclo: R/2025-09-23/P1M

post/requestBody/data/riskSignals/manual/properties

Removido - "isCallingProgress"

Remoção

post/requestBody/data/riskSignals/manual/properties

Adicionado - "isCallInProgress"

Adição

post/requestBody/data/riskSignals/manual/accountTenure

Adicionado - "example"

Adição

21/05/2020

post/requestBody/data/riskSignals/manual/antennaInformation

Adicionado - "example"

Adição

CellIdentityLte:{mCi=2******60 mPci=274 mTac=5***1 mEarfcn=9510 mBands=[28] mBandwidth=2147483647 mMcc=724 mMnc=10 mAlphaLong=VIVO mAlphaShort=VIVO mAdditionalPlmns={} mCsgInfo=null}

post/requestBody/data/riskSignals/manual/deviceId

Alterado - "description"

Alteração

ID único do dispositivo gerado pela plataforma.

ID único do dispositivo gerado pela plataforma.  Utiliza-se a propriedade do sistema que identifica a combinação de usuário logado, chave de assinatura do aplicativo e dispositivo. 
[Android] Informação obtida através do [link](https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID). 
[iOS] Informação obtida através do [link](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor/).

post/requestBody/data/riskSignals/manual/deviceId

Alterado - "example"

Alteração

00000000-54b3-e7c7-0000-000046bffd97

00aa11bb22cc33dd