Adaptações para Consultas de Recursos na API Pagamentos entre Versões 4.0.1 e 5.0.0

data>payment>purpose

Obrigatório quando data>payment>type for igual a PIX (único valor possível, portanto sempre obrigatório).

enum

Finalidade da transação. Valores: IMMEDIATE, SINGLE_SCHEDULED, RECURRENT_SCHEDULED, WITHDRAW, CHANGE.

Derivar o valor a partir dos dados do consentimento v4.0.1, conforme regra da seção 1.5.

data>payment>details>payloadJWS

Obrigatório quando data>payment>details>localInstrument for igual a APDN ou QRDN.

string

Payload JWS obtido pela ITP na leitura do QR dinâmico.

Retornar o valor fixo inexistente.inexistente.inexistente, conforme seção 1.5. Não há como derivar o valor real, pois o JWT é gerado pelo PSP do Recebedor no momento da leitura do QR e não foi capturado em recursos da v4.0.1.

data>businessEntity>document>identification

Pattern: ^\d{14}$.

Pattern: ^[0-9A-Z]{12}[0-9]{2}$.

Sem ação. Devolver valor atual.

data>creditor>cpfCnpj

Pattern: ^\d{11}$|^\d{14}$.

Pattern: ^([0-9]{11})$|^([0-9A-Z]{12}[0-9]{2})$.

Sem ação. Devolver valor atual.

data>creditor>name

Pattern: ^([A-Za-zÀ-ÖØ-öø-ÿ,.@:&*+_<>()!?/\\$%\d' -]+)$.

Pattern: ^[\u0020-\u007E\u00A1-\u00FF]+$.

Sem ação. Devolver valor atual.

data>debtorAccount>ispb

Pattern: ^[0-9]{8}$.

Pattern: ^[0-9A-Z]{8}$.

Sem ação. Devolver valor atual.

data>payment>details>creditorAccount>ispb

Pattern: ^[0-9]{8}$.

Pattern: ^[0-9A-Z]{8}$.

Sem ação. Devolver valor atual.

data>payment>details>localInstrument

Enum: MANU, DICT, QRDN, QRES, INIC.

Enum ampliado: MANU, DICT, APDN, QRDN, APES, QRES, INIC.

Sem ação. Devolver o valor original informado na criação do consentimento.

data>payment>schedule>additionalInformation

Inexistente no nível raiz do schedule. Na v4.0.1, o campo additionalInformation existia apenas dentro de schedule>custom, obrigatório somente para agendamento custom.

Promovido ao nível raiz do schedule com required, tornando-se obrigatório para todos os tipos de agendamento (single, daily, weekly, monthly, custom).

Para consentimentos custom da v4.0.1, derivar o valor a partir de schedule>custom>additionalInformation. Para os demais tipos de agendamento, retornar o valor fixo Informação não disponível para consentimentos originados em versão anterior, conforme seção 1.5.

data>rejectionReason>code

Enum sem AUTENTICACAO_DIVERGENTE e PERMISSAO_INSUFICIENTE.

Novos valores adicionados ao enum.

Sem ação. Devolver valor atual.

data>payment>schedule>custom>additionalInformation

Realocado para o nível raiz do schedule (ver seção 1.3). Não se trata de descontinuação: o campo deixou de existir dentro de custom e passou a ser obrigatório no nível raiz do schedule.

Para consentimentos custom da v4.0.1, o valor deve ser utilizado para preencher data>payment>schedule>additionalInformation na resposta da v5, conforme seção 1.3.

Campo data>payment>date preenchido (pagamento único e imediato, sem objeto schedule).

IMMEDIATE

Objeto data>payment>schedule>single preenchido.

SINGLE_SCHEDULED

Objeto data>payment>schedule>daily, weekly, monthly ou custom preenchido.

RECURRENT_SCHEDULED

data>payment>details>payloadJWS

inexistente.inexistente.inexistente

Satisfaz o pattern ^[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+\.[A-Za-z0-9_-]+$ (três segmentos). O valor é um sentinela e não representa um JWS válido; a detentora não deve tentar decodificá-lo como JWT.

data>payment>schedule>additionalInformation

Informação não disponível para consentimentos originados em versão anterior

Satisfaz o pattern [\w\W\s]* e o limite de 255 caracteres.

data>cnpjInitiator

Pattern: ^\d{14}$.

Pattern: ^[0-9A-Z]{12}[0-9]{2}$.

Sem ação. Devolver valor atual.

data>creditorAccount>ispb

Pattern: ^[0-9]{8}$.

Pattern: ^[0-9A-Z]{8}$.

Sem ação. Devolver valor atual.

data>endToEndId

Pattern: ^([E])([0-9]{8})([0-9]{4})....

Pattern: ^([E])([0-9A-Z]{8})([0-9]{4})....

Sem ação. Devolver valor atual.

data>localInstrument

Enum: MANU, DICT, QRDN, QRES, INIC.

Enum ampliado: MANU, DICT, APDN, QRDN, APES, QRES, INIC.

Sem ação. Devolver o valor original informado na criação do pagamento.

data>rejectionReason>code

Enum sem CHAVE_PIX_DIVERGENTE_AGENDAMENTO_LIQUIDACAO, CONTA_NAO_PERMITE_PAGAMENTO, QRCODE_INVALIDO e os granulares de FALHA_INFRAESTRUTURA_*.

Novos valores adicionados ao enum.

Sem ação. Devolver valor atual.