Adaptações para consultas de recursos entre as versões 1.0.0 e 2.0.0 ou superiores da API Pagamentos Automáticos

data>authorisedAtDateTime

Opcional

date-time

Obrigatório quando o consentimento transita para AUTHORISED.

Não enviar o campo no retorno.

data>updatedAtDateTime

Opcional

date-time

Data/hora de atualização pelo usuário pagador (aplicável apenas para edições no Pix Automático).

Não enviar o campo no retorno.

data>approvalDueDate

Opcional

date

Data máxima para aprovação de consentimentos em PARTIALLY_ACCEPTED.

Não enviar o campo no retorno.

data>recurringConfiguration>sweeping>useOverdraftLimit

Obrigatório

boolean

Indica se o usuário autorizou uso de limite pré-aprovado (cheque especial).

Se a instituição possui o cheque especial e o cliente dono do consentimento possui o produto cheque especial, o valor retornado deve ser true, caso contrário, false. Recomendamos que os cliente sejam avisados da modificação sobre seu consentimento passar a utilizar cheque especial.

data>recurringConfiguration>sweeping>startDateTime

Obrigatório

date-time

Se não enviado, assume o valor de creationDateTime.

Consentimentos da versão 1 consultados na versão 2, que não possuem o campo data>recurringConfiguration>sweeping>startDateTime definido, devem retornar no campo data>recurringConfiguration>sweeping>startDateTime o valor presente no campo data>recurringConfiguration>sweeping>creationDateTime. Isso representa um consentimento criado com validade a partir da data de criação. <br>Caso já exista valor no campo, este deve ser retornado.

data>expirationDateTime

Sem restrição específica.

Nova regra: Para Pix Automático, horário deve ser 23:59:59 UTC.

Sem ação. Devolver valor atual caso exista.

data>creditors[0]

Sem regras de validação específicas.

Novas regras: CPF do credor deve ser igual ao do loggedUser (pessoa física).
CNPJ deve ter a mesma raiz do businessEntity (pessoa jurídica).

Sem ação. Devolver valor atual.

data>debtorAccount>ibgeTownCode

Obrigatório apenas para recurringConfiguration "automatic".

Ampliação: Obrigatório também quando o consentimento passar por AUTHORISED.

Sem ação. Devolver valor atual.

data>rejection>reason>code

Valores do enum sem AUTENTICACAO_DIVERGENTE.

Novo valor: AUTENTICACAO_DIVERGENTE (autenticação divergente).

Sem ação. Devolver valor atual.

data>status

Descrição sem menção a transições de estado.

Adição de contexto sobre máquina de estados (ex: PARTIALLY_ACCEPTED).

Sem ação. Devolver valor atual.

data>recurringConfiguration>sweeping>startDateTime (antigo <br>data>startDateTime)

Opcional

Obrigatório

Sem ação. Devolver valor atual.

data>proxy

opcional

string

Chave Pix do recebedor (CPF, CNPJ, e-mail, etc.). Obrigatório se localInstrument=DICT.

Se a transação exigiu o envio do proxy pelo ITP para ocorrer a liquidação na v1, o campo deverá ser retornado durante a consulta à v2.

data>localInstrument

obrigatório

enum

Define a forma de iniciação do pagamento (MANU, DICT, INIC).

O campo deverá ser retornado durante a consulta à v2 com o valor original informado na sua criação.

data>originalRecurringPaymentId

opcional

string

Identificador da tentativa original de pagamento que falhou (obrigatório para retentativas).

Sem ação

data>paymentReference

opcional

string

Referência da recorrência (ex: W50-2024 para pagamentos semanais).

Sem ação

data>ibgeTownCode

Não está presente na versão 2.0.0 (removido em detrimento de sua presença já existir no consentimento).

Sem ação

data>endToEndId

Sem menção a Pix Automático.

Nova regra: Para Pix Automático, deve usar data agendada e horário fixo 15:00 UTC.

Sem ação

data>status

PDNG aplicável a qualquer cenário.

PDNG não se aplica a Transferências Inteligentes.

Sem ação

data>rejectionReason>code

14 opções de códigos de rejeição.

Novos códigos adicionados: LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO, LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO, CONSENTIMENTO_REVOGADO, FORA_PRAZO_PERMITIDO, DETALHE_TENTATIVA_INVALIDO, DETALHE_PAGAMENTO_INVALIDO.

Sem ação

data>cancellation>reason

Incluía CANCELADO_MULTIPLAS_ALCADAS.

Remoção de valor: CANCELADO_MULTIPLAS_ALCADAS não está mais disponível.

Sem ação. Era um bug de especificação que não deveria ocorrer desde o nascimento do produto, uma vez que nunca foi possível ter múltipla alçada no pagamento em si, apenas no consentimento.

data>transactionIdentification

Sem restrições específicas.

Nova restrição: Campo condicional baseado em localInstrument (ex: obrigatório para INIC).

Se a transação exigiu o envio do transactionIdentification pelo ITP para ocorrer a liquidação na v1, o campo deverá ser retornado durante a consulta à v2.

data>document>rel

Sem enumeração explícita.

Enum adicionado: [ CPF, CNPJ ].

Sem ação

data>date

Descrição genérica sobre data do pagamento.

Formato explícito: Timezone UTC-3 e formatação RFC-3339.

Sem ação

Campo (XPath)

Versão 1.0.0

Versão 2.0.0

Ação

data>creditorAccount

Opcional

Obrigatório

Ensejou o versionamento para versão 2.1.0, lançada em 25/04, tornando o campo opcional nos retornos de consulta de pagamento.

data>localInstument

Inexistente na consulta

Obrigatório

O campo deverá ser retornado durante a consulta à v2 com o valor original informado na sua criação.