diff --git a/dictionary/automaticPaymentsGetPixRecurringPaymentsPaymentId_v2.csv b/dictionary/automaticPaymentsGetPixRecurringPaymentsPaymentId_v2.csv index fedc71090..6ad3a7f9a 100644 --- a/dictionary/automaticPaymentsGetPixRecurringPaymentsPaymentId_v2.csv +++ b/dictionary/automaticPaymentsGetPixRecurringPaymentsPaymentId_v2.csv @@ -71,6 +71,7 @@ Motivo da rejeição do pagamento. Informações complementares sobre o motivo d - 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: O máximo de tentativas de liquidação permitidas pelo arranjo foi atingido. +- CONSENTIMENTO_REVOGADO [Restrição] Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). ";Texto;;Obrigatório;;"SALDO_INSUFICIENTE @@ -90,7 +91,8 @@ LIMITE_PERIODO_VALOR_EXCEDIDO LIMITE_PERIODO_QUANTIDADE_EXCEDIDO LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO -LIMITE_TENTATIVAS_EXCEDIDO";1;1;" Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). +LIMITE_TENTATIVAS_EXCEDIDO +CONSENTIMENTO_REVOGADO";1;1;" Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). ";Não permitido;string;SALDO_INSUFICIENTE; /data/rejectionReason/detail;detail;"Detalhe sobre o código identificador do motivo de rejeição. @@ -112,6 +114,7 @@ LIMITE_TENTATIVAS_EXCEDIDO";1;1;" Esse motivo deverá ser enviado quando o campo - 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. +- CONSENTIMENTO_REVOGADO: O pagamento estava associado a um consentimento que foi revogado. ";Texto;2048;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;; /data/cnpjInitiator;cnpjInitiator;CNPJ do Iniciador de Pagamento devidamente habilitado para a prestação de Serviço de Iniciação no Pix.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;50685362000135; /data/payment;payment;Objeto contendo as informações do pagamento.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; @@ -238,3 +241,12 @@ Esta validação é opcional caso o localInstrument for igual a INIC. DICT INIC";1;1;" Caso consentimento associado a tentativa de pagamento seja para Pix automático (objeto “automatic” selecionado no oneOf do campo ""/data/recurringConfiguration""), apenas o método MANU é permitido. ";Não permitido;string;DICT; +/data/lastRetryRecurringPaymentIds;lastRetryRecurringPaymentIds;"Conjunto de recurringPaymentIds correspondentes às tentativas de pagamentos anteriores. + +[Restrições] +Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. +Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. +";Lista;100;Condicional;^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$;;0;4;" +Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. +Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. +";Não permitido;array;TXpRMU9UQTROMWhZV2xSU1FUazJSMDl;1 diff --git a/dictionary/automaticPaymentsGetPixRecurringPayments_v2.csv b/dictionary/automaticPaymentsGetPixRecurringPayments_v2.csv index 3db8d678a..03f3b9733 100644 --- a/dictionary/automaticPaymentsGetPixRecurringPayments_v2.csv +++ b/dictionary/automaticPaymentsGetPixRecurringPayments_v2.csv @@ -70,6 +70,7 @@ Motivo da rejeição do pagamento. Informações complementares sobre o motivo d - 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 [Restrição] Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). ";Texto;;Obrigatório;;"SALDO_INSUFICIENTE @@ -88,7 +89,8 @@ LIMITE_PERIODO_VALOR_EXCEDIDO LIMITE_PERIODO_QUANTIDADE_EXCEDIDO TITULARIDADE_INCONSISTENTE LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO -LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO";1;1;" Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). +LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO +CONSENTIMENTO_REVOGADO";1;1;" Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). ";Não permitido;string;SALDO_INSUFICIENTE; /data/rejectionReason/detail;detail;"Detalhe sobre o código identificador do motivo de rejeição. @@ -109,6 +111,7 @@ LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO";1;1;" Esse motivo deverá ser env - 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. ";Texto;2048;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;; /data/payment;payment;Objeto contendo as informações do pagamento.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/payment/amount;amount;"Valor da transação com 2 casas decimais. @@ -125,3 +128,12 @@ Os caracteres permitidos no contexto do Pix para o campo txid (EMV 62-05) são:L /data/document/identification;identification;Número do documento de identificação oficial do titular pessoa natural ou jurídica.;Texto;14;Obrigatório;^(?:\d{11}|\d{14})$;;1;1;"";Não permitido;string;11111111111111;11 /data/document/rel;rel;Tipo do documento de identificação oficial do titular pessoa natural ou jurídica.;Texto;;Obrigatório;;"CPF CNPJ";1;1;"";Não permitido;string;CNPJ; +/data/lastRetryRecurringPaymentIds;lastRetryRecurringPaymentIds;"Conjunto de recurringPaymentIds correspondentes às tentativas de pagamentos anteriores. + +[Restrições] +Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. +Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. +";Lista;100;Condicional;^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$;;0;4;" +Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. +Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. +";Não permitido;array;TXpRMU9UQTROMWhZV2xSU1FUazJSMDl;1 diff --git a/dictionary/automaticPaymentsGetRecurringConsentsConsentId_v2.csv b/dictionary/automaticPaymentsGetRecurringConsentsConsentId_v2.csv index 95f5adacd..c4f2813cc 100644 --- a/dictionary/automaticPaymentsGetRecurringConsentsConsentId_v2.csv +++ b/dictionary/automaticPaymentsGetRecurringConsentsConsentId_v2.csv @@ -190,29 +190,6 @@ MENSAL ANUAL SEMESTRAL TRIMESTRAL";1;1;"";Não permitido;string;SEMANAL; -/data/recurringConfiguration/automatic/dayOfMonth;dayOfMonth;"Dia fixo do mês que está prevista a transação. Caso consentimento seja para pagamentos trimestrais ou semestrais, o campo representa o dia do mês selecionado no campo `/data/recurringConfiguration/automatic/month` em que ocorrerá primeira cobrança. - -[Restrição] Campo deve ser enviado quando o campo /data/recurringConfiguration/automatic/period for igual a MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL. -";Inteiro;31;Condicional;;;0;1;" Campo deve ser enviado quando o campo /data/recurringConfiguration/automatic/period for igual a MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL. -";Não permitido;integer;10;1 -/data/recurringConfiguration/automatic/dayOfWeek;dayOfWeek;"Dia da semana que está prevista a transação. -- SEGUNDA_FEIRA -- TERCA_FEIRA -- QUARTA_FEIRA -- QUINTA_FEIRA -- SEXTA_FEIRA -- SABADO -- DOMINGO - -[Restrição] Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a SEMANAL. -";Texto;;Condicional;;"SEGUNDA_FEIRA -TERCA_FEIRA -QUARTA_FEIRA -QUINTA_FEIRA -SEXTA_FEIRA -SABADO -DOMINGO";0;1;" Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a SEMANAL. -";Não permitido;string;SEGUNDA_FEIRA; /data/recurringConfiguration/automatic/month;month;"Mês previstos para ocorrer transações. Caso consentimento seja para pagamentos trimestrais ou semestrais, o campo representa o mês da primeira cobrança. - JANEIRO - FEVEREIRO @@ -246,34 +223,39 @@ DEZEMBRO";0;1;" Campo deve ser enviado quando o campo `/data/recurringConfigurat /data/recurringConfiguration/automatic/contractDebtor/document;document;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/recurringConfiguration/automatic/contractDebtor/document/identification;identification;Número do documento de identificação oficial do cliente devedor do contrato.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;11111111111111; /data/recurringConfiguration/automatic/contractDebtor/document/rel;rel;Tipo do documento de identificação oficial do cliente devedor do contrato.;Texto;4;Obrigatório;^[A-Z]{4}$;;1;1;"";Não permitido;string;CNPJ; -/data/recurringConfiguration/automatic/immediatePayment;immediatePayment;Definições para transação imediata.;Objeto;;Opcional;;;0;1;"";Não permitido;object;; -/data/recurringConfiguration/automatic/immediatePayment/type;type;"Este campo define o tipo de pagamento que será iniciado após a autorização do consentimento. +/data/recurringConfiguration/automatic/firstPayment;firstPayment;"Definições para o primeiro pagamento. É considerado como o pagamento da adesão ao serviço pelo usuário pagador. + +- A conta de crédito informada deve pertencer ao mesmo CNPJ informado no campo “/data/creditors/cpfCnpj” +- A conta de crédito informada no momento do primeiro pagamento deve ser a mesma informada dentro deste objeto. +Caso não respeitado, o detentor deve rejeitar o pagamento com o motivo DETALHE_PAGAMENTO_INVALIDO, sincronamente (HTTP 422) ou assincronamente (HTTP 200) +";Objeto;;Opcional;;;0;1;"";Não permitido;object;; +/data/recurringConfiguration/automatic/firstPayment/type;type;"Este campo define o tipo de pagamento que será iniciado após a autorização do consentimento. ";Texto;;Obrigatório;;PIX;1;1;"";Não permitido;string;PIX; -/data/recurringConfiguration/automatic/immediatePayment/date;date;"Define a data alvo da liquidação do pagamento. +/data/recurringConfiguration/automatic/firstPayment/date;date;"Define a data alvo da liquidação do pagamento. O fuso horário de Brasília deve ser utilizado para criação e racionalização sobre os dados deste campo. ";Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-01-01; -/data/recurringConfiguration/automatic/immediatePayment/currency;currency;"Código da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'. +/data/recurringConfiguration/automatic/firstPayment/currency;currency;"Código da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'. Todos os valores monetários informados estão representados com a moeda vigente do Brasil. ";Texto;3;Obrigatório;^([A-Z]{3})$;;1;1;"";Não permitido;string;BRL; -/data/recurringConfiguration/automatic/immediatePayment/amount;amount;"Valor da transação com 2 casas decimais. +/data/recurringConfiguration/automatic/firstPayment/amount;amount;"Valor da transação com 2 casas decimais. ";Texto;19;Obrigatório;^((\d{1,16}\.\d{2}))$;;1;1;"";Não permitido;string;100000.12;4 -/data/recurringConfiguration/automatic/immediatePayment/remittanceInformation;remittanceInformation;"Deve ser preenchido sempre que o usuário pagador inserir alguma informação adicional em um pagamento, a ser enviada ao recebedor. +/data/recurringConfiguration/automatic/firstPayment/remittanceInformation;remittanceInformation;"Deve ser preenchido sempre que o usuário pagador inserir alguma informação adicional em um pagamento, a ser enviada ao recebedor. ";Texto;140;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Pagamento da nota RSTO035-002; -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount;creditorAccount;"Recebe os dados de conta do usuário recebedor. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount;creditorAccount;"Recebe os dados de conta do usuário recebedor. ";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/ispb;ispb;"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantâneos) somente com números. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/ispb;ispb;"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantâneos) somente com números. ";Texto;8;Obrigatório;^[0-9]{8}$;;1;1;"";Não permitido;string;12345678;8 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/issuer;issuer;"Código da Agência emissora da conta sem dígito. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/issuer;issuer;"Código da Agência emissora da conta sem dígito. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória). [Restrição] Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA). ";Texto;4;Obrigatório;^[0-9]{1,4}$;;1;1;" Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA). ";Não permitido;string;1774;1 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/number;number;"Deve ser preenchido com o número da conta transacional do usuário pagador, com dígito verificador (se este existir), +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/number;number;"Deve ser preenchido com o número da conta transacional do usuário pagador, com dígito verificador (se este existir), se houver valor alfanumérico, este deve ser convertido para 0. ";Texto;20;Obrigatório;^[0-9]{1,20}$;;1;1;"";Não permitido;string;1234567890;1 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/accountType;accountType;"Tipos de contas usadas para pagamento. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/accountType;accountType;"Tipos de contas usadas para pagamento. Modalidades tradicionais previstas pela Resolução 4.753, não contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrônica. Segue descrição de cada valor do ENUM. diff --git a/dictionary/automaticPaymentsPatchPixRecurringPaymentsPaymentId_v2.csv b/dictionary/automaticPaymentsPatchPixRecurringPaymentsPaymentId_v2.csv index 481a5d097..35ce8eda9 100644 --- a/dictionary/automaticPaymentsPatchPixRecurringPaymentsPaymentId_v2.csv +++ b/dictionary/automaticPaymentsPatchPixRecurringPaymentsPaymentId_v2.csv @@ -71,6 +71,7 @@ Motivo da rejeição do pagamento. Informações complementares sobre o motivo d - 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: O máximo de tentativas de liquidação permitidas pelo arranjo foi atingido. +- CONSENTIMENTO_REVOGADO [Restrição] Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). ";Texto;;Obrigatório;;"SALDO_INSUFICIENTE @@ -90,7 +91,8 @@ LIMITE_PERIODO_VALOR_EXCEDIDO LIMITE_PERIODO_QUANTIDADE_EXCEDIDO LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO -LIMITE_TENTATIVAS_EXCEDIDO";1;1;" Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). +LIMITE_TENTATIVAS_EXCEDIDO +CONSENTIMENTO_REVOGADO";1;1;" Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). ";Não permitido;string;SALDO_INSUFICIENTE; /data/rejectionReason/detail;detail;"Detalhe sobre o código identificador do motivo de rejeição. @@ -112,6 +114,7 @@ LIMITE_TENTATIVAS_EXCEDIDO";1;1;" Esse motivo deverá ser enviado quando o campo - 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. +- CONSENTIMENTO_REVOGADO: O pagamento estava associado a um consentimento que foi revogado. ";Texto;2048;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;; /data/cnpjInitiator;cnpjInitiator;CNPJ do Iniciador de Pagamento devidamente habilitado para a prestação de Serviço de Iniciação no Pix.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;50685362000135; /data/payment;payment;Objeto contendo as informações do pagamento.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; @@ -238,3 +241,12 @@ Esta validação é opcional caso o localInstrument for igual a INIC. DICT INIC";1;1;" Caso consentimento associado a tentativa de pagamento seja para Pix automático (objeto “automatic” selecionado no oneOf do campo ""/data/recurringConfiguration""), apenas o método MANU é permitido. ";Não permitido;string;DICT; +/data/lastRetryRecurringPaymentIds;lastRetryRecurringPaymentIds;"Conjunto de recurringPaymentIds correspondentes às tentativas de pagamentos anteriores. + +[Restrições] +Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. +Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. +";Lista;100;Condicional;^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$;;0;4;" +Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. +Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. +";Não permitido;array;TXpRMU9UQTROMWhZV2xSU1FUazJSMDl;1 diff --git a/dictionary/automaticPaymentsPatchRecurringConsentsConsentId_v2.csv b/dictionary/automaticPaymentsPatchRecurringConsentsConsentId_v2.csv index 95f5adacd..c4f2813cc 100644 --- a/dictionary/automaticPaymentsPatchRecurringConsentsConsentId_v2.csv +++ b/dictionary/automaticPaymentsPatchRecurringConsentsConsentId_v2.csv @@ -190,29 +190,6 @@ MENSAL ANUAL SEMESTRAL TRIMESTRAL";1;1;"";Não permitido;string;SEMANAL; -/data/recurringConfiguration/automatic/dayOfMonth;dayOfMonth;"Dia fixo do mês que está prevista a transação. Caso consentimento seja para pagamentos trimestrais ou semestrais, o campo representa o dia do mês selecionado no campo `/data/recurringConfiguration/automatic/month` em que ocorrerá primeira cobrança. - -[Restrição] Campo deve ser enviado quando o campo /data/recurringConfiguration/automatic/period for igual a MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL. -";Inteiro;31;Condicional;;;0;1;" Campo deve ser enviado quando o campo /data/recurringConfiguration/automatic/period for igual a MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL. -";Não permitido;integer;10;1 -/data/recurringConfiguration/automatic/dayOfWeek;dayOfWeek;"Dia da semana que está prevista a transação. -- SEGUNDA_FEIRA -- TERCA_FEIRA -- QUARTA_FEIRA -- QUINTA_FEIRA -- SEXTA_FEIRA -- SABADO -- DOMINGO - -[Restrição] Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a SEMANAL. -";Texto;;Condicional;;"SEGUNDA_FEIRA -TERCA_FEIRA -QUARTA_FEIRA -QUINTA_FEIRA -SEXTA_FEIRA -SABADO -DOMINGO";0;1;" Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a SEMANAL. -";Não permitido;string;SEGUNDA_FEIRA; /data/recurringConfiguration/automatic/month;month;"Mês previstos para ocorrer transações. Caso consentimento seja para pagamentos trimestrais ou semestrais, o campo representa o mês da primeira cobrança. - JANEIRO - FEVEREIRO @@ -246,34 +223,39 @@ DEZEMBRO";0;1;" Campo deve ser enviado quando o campo `/data/recurringConfigurat /data/recurringConfiguration/automatic/contractDebtor/document;document;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/recurringConfiguration/automatic/contractDebtor/document/identification;identification;Número do documento de identificação oficial do cliente devedor do contrato.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;11111111111111; /data/recurringConfiguration/automatic/contractDebtor/document/rel;rel;Tipo do documento de identificação oficial do cliente devedor do contrato.;Texto;4;Obrigatório;^[A-Z]{4}$;;1;1;"";Não permitido;string;CNPJ; -/data/recurringConfiguration/automatic/immediatePayment;immediatePayment;Definições para transação imediata.;Objeto;;Opcional;;;0;1;"";Não permitido;object;; -/data/recurringConfiguration/automatic/immediatePayment/type;type;"Este campo define o tipo de pagamento que será iniciado após a autorização do consentimento. +/data/recurringConfiguration/automatic/firstPayment;firstPayment;"Definições para o primeiro pagamento. É considerado como o pagamento da adesão ao serviço pelo usuário pagador. + +- A conta de crédito informada deve pertencer ao mesmo CNPJ informado no campo “/data/creditors/cpfCnpj” +- A conta de crédito informada no momento do primeiro pagamento deve ser a mesma informada dentro deste objeto. +Caso não respeitado, o detentor deve rejeitar o pagamento com o motivo DETALHE_PAGAMENTO_INVALIDO, sincronamente (HTTP 422) ou assincronamente (HTTP 200) +";Objeto;;Opcional;;;0;1;"";Não permitido;object;; +/data/recurringConfiguration/automatic/firstPayment/type;type;"Este campo define o tipo de pagamento que será iniciado após a autorização do consentimento. ";Texto;;Obrigatório;;PIX;1;1;"";Não permitido;string;PIX; -/data/recurringConfiguration/automatic/immediatePayment/date;date;"Define a data alvo da liquidação do pagamento. +/data/recurringConfiguration/automatic/firstPayment/date;date;"Define a data alvo da liquidação do pagamento. O fuso horário de Brasília deve ser utilizado para criação e racionalização sobre os dados deste campo. ";Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-01-01; -/data/recurringConfiguration/automatic/immediatePayment/currency;currency;"Código da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'. +/data/recurringConfiguration/automatic/firstPayment/currency;currency;"Código da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'. Todos os valores monetários informados estão representados com a moeda vigente do Brasil. ";Texto;3;Obrigatório;^([A-Z]{3})$;;1;1;"";Não permitido;string;BRL; -/data/recurringConfiguration/automatic/immediatePayment/amount;amount;"Valor da transação com 2 casas decimais. +/data/recurringConfiguration/automatic/firstPayment/amount;amount;"Valor da transação com 2 casas decimais. ";Texto;19;Obrigatório;^((\d{1,16}\.\d{2}))$;;1;1;"";Não permitido;string;100000.12;4 -/data/recurringConfiguration/automatic/immediatePayment/remittanceInformation;remittanceInformation;"Deve ser preenchido sempre que o usuário pagador inserir alguma informação adicional em um pagamento, a ser enviada ao recebedor. +/data/recurringConfiguration/automatic/firstPayment/remittanceInformation;remittanceInformation;"Deve ser preenchido sempre que o usuário pagador inserir alguma informação adicional em um pagamento, a ser enviada ao recebedor. ";Texto;140;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Pagamento da nota RSTO035-002; -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount;creditorAccount;"Recebe os dados de conta do usuário recebedor. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount;creditorAccount;"Recebe os dados de conta do usuário recebedor. ";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/ispb;ispb;"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantâneos) somente com números. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/ispb;ispb;"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantâneos) somente com números. ";Texto;8;Obrigatório;^[0-9]{8}$;;1;1;"";Não permitido;string;12345678;8 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/issuer;issuer;"Código da Agência emissora da conta sem dígito. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/issuer;issuer;"Código da Agência emissora da conta sem dígito. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória). [Restrição] Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA). ";Texto;4;Obrigatório;^[0-9]{1,4}$;;1;1;" Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA). ";Não permitido;string;1774;1 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/number;number;"Deve ser preenchido com o número da conta transacional do usuário pagador, com dígito verificador (se este existir), +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/number;number;"Deve ser preenchido com o número da conta transacional do usuário pagador, com dígito verificador (se este existir), se houver valor alfanumérico, este deve ser convertido para 0. ";Texto;20;Obrigatório;^[0-9]{1,20}$;;1;1;"";Não permitido;string;1234567890;1 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/accountType;accountType;"Tipos de contas usadas para pagamento. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/accountType;accountType;"Tipos de contas usadas para pagamento. Modalidades tradicionais previstas pela Resolução 4.753, não contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrônica. Segue descrição de cada valor do ENUM. diff --git a/dictionary/automaticPaymentsPostPixRecurringPayments_v2.csv b/dictionary/automaticPaymentsPostPixRecurringPayments_v2.csv index 8367942b1..8c0616646 100644 --- a/dictionary/automaticPaymentsPostPixRecurringPayments_v2.csv +++ b/dictionary/automaticPaymentsPostPixRecurringPayments_v2.csv @@ -71,6 +71,7 @@ Motivo da rejeição do pagamento. Informações complementares sobre o motivo d - 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: O máximo de tentativas de liquidação permitidas pelo arranjo foi atingido. +- CONSENTIMENTO_REVOGADO [Restrição] Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). ";Texto;;Obrigatório;;"SALDO_INSUFICIENTE @@ -90,7 +91,8 @@ LIMITE_PERIODO_VALOR_EXCEDIDO LIMITE_PERIODO_QUANTIDADE_EXCEDIDO LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO -LIMITE_TENTATIVAS_EXCEDIDO";1;1;" Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). +LIMITE_TENTATIVAS_EXCEDIDO +CONSENTIMENTO_REVOGADO";1;1;" Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). ";Não permitido;string;SALDO_INSUFICIENTE; /data/rejectionReason/detail;detail;"Detalhe sobre o código identificador do motivo de rejeição. @@ -112,6 +114,7 @@ LIMITE_TENTATIVAS_EXCEDIDO";1;1;" Esse motivo deverá ser enviado quando o campo - 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. +- CONSENTIMENTO_REVOGADO: O pagamento estava associado a um consentimento que foi revogado. ";Texto;2048;Obrigatório;[\w\W\s]*;;1;1;"";Não permitido;string;; /data/cnpjInitiator;cnpjInitiator;CNPJ do Iniciador de Pagamento devidamente habilitado para a prestação de Serviço de Iniciação no Pix.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;50685362000135; /data/payment;payment;Objeto contendo as informações do pagamento.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; @@ -240,3 +243,12 @@ Quando não respeitada essa regra, deve ser retornado pelo detentor, de maneira ";Texto;14;Obrigatório;^(?:\d{11}|\d{14})$;;1;1;"";Não permitido;string;11111111111111;11 /data/document/rel;rel;Tipo do documento de identificação oficial do titular pessoa natural ou jurídica.;Texto;;Obrigatório;;"CPF CNPJ";1;1;"";Não permitido;string;CNPJ; +/data/lastRetryRecurringPaymentIds;lastRetryRecurringPaymentIds;"Conjunto de recurringPaymentIds correspondentes às tentativas de pagamentos anteriores. + +[Restrições] +Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. +Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. +";Lista;100;Condicional;^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$;;0;4;" +Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. +Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. +";Não permitido;array;TXpRMU9UQTROMWhZV2xSU1FUazJSMDl;1 diff --git a/dictionary/automaticPaymentsPostRecurringConsents_v2.csv b/dictionary/automaticPaymentsPostRecurringConsents_v2.csv index 08d1a06d6..1d1303619 100644 --- a/dictionary/automaticPaymentsPostRecurringConsents_v2.csv +++ b/dictionary/automaticPaymentsPostRecurringConsents_v2.csv @@ -193,29 +193,6 @@ MENSAL ANUAL SEMESTRAL TRIMESTRAL";1;1;"";Não permitido;string;SEMANAL; -/data/recurringConfiguration/automatic/dayOfMonth;dayOfMonth;"Dia fixo do mês que está prevista a transação. Caso consentimento seja para pagamentos trimestrais ou semestrais, o campo representa o dia do mês selecionado no campo `/data/recurringConfiguration/automatic/month` em que ocorrerá primeira cobrança. - -[Restrição] Campo deve ser enviado quando o campo /data/recurringConfiguration/automatic/period for igual a MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL. -";Inteiro;31;Condicional;;;0;1;" Campo deve ser enviado quando o campo /data/recurringConfiguration/automatic/period for igual a MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL. -";Não permitido;integer;10;1 -/data/recurringConfiguration/automatic/dayOfWeek;dayOfWeek;"Dia da semana que está prevista a transação. -- SEGUNDA_FEIRA -- TERCA_FEIRA -- QUARTA_FEIRA -- QUINTA_FEIRA -- SEXTA_FEIRA -- SABADO -- DOMINGO - -[Restrição] Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a SEMANAL. -";Texto;;Condicional;;"SEGUNDA_FEIRA -TERCA_FEIRA -QUARTA_FEIRA -QUINTA_FEIRA -SEXTA_FEIRA -SABADO -DOMINGO";0;1;" Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a SEMANAL. -";Não permitido;string;SEGUNDA_FEIRA; /data/recurringConfiguration/automatic/month;month;"Mês previstos para ocorrer transações. Caso consentimento seja para pagamentos trimestrais ou semestrais, o campo representa o mês da primeira cobrança. - JANEIRO - FEVEREIRO @@ -249,34 +226,39 @@ DEZEMBRO";0;1;" Campo deve ser enviado quando o campo `/data/recurringConfigurat /data/recurringConfiguration/automatic/contractDebtor/document;document;;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; /data/recurringConfiguration/automatic/contractDebtor/document/identification;identification;Número do documento de identificação oficial do cliente devedor do contrato.;Texto;14;Obrigatório;^\d{14}$;;1;1;"";Não permitido;string;11111111111111; /data/recurringConfiguration/automatic/contractDebtor/document/rel;rel;Tipo do documento de identificação oficial do cliente devedor do contrato.;Texto;4;Obrigatório;^[A-Z]{4}$;;1;1;"";Não permitido;string;CNPJ; -/data/recurringConfiguration/automatic/immediatePayment;immediatePayment;Definições para transação imediata.;Objeto;;Opcional;;;0;1;"";Não permitido;object;; -/data/recurringConfiguration/automatic/immediatePayment/type;type;"Este campo define o tipo de pagamento que será iniciado após a autorização do consentimento. +/data/recurringConfiguration/automatic/firstPayment;firstPayment;"Definições para o primeiro pagamento. É considerado como o pagamento da adesão ao serviço pelo usuário pagador. + +- A conta de crédito informada deve pertencer ao mesmo CNPJ informado no campo “/data/creditors/cpfCnpj” +- A conta de crédito informada no momento do primeiro pagamento deve ser a mesma informada dentro deste objeto. +Caso não respeitado, o detentor deve rejeitar o pagamento com o motivo DETALHE_PAGAMENTO_INVALIDO, sincronamente (HTTP 422) ou assincronamente (HTTP 200) +";Objeto;;Opcional;;;0;1;"";Não permitido;object;; +/data/recurringConfiguration/automatic/firstPayment/type;type;"Este campo define o tipo de pagamento que será iniciado após a autorização do consentimento. ";Texto;;Obrigatório;;PIX;1;1;"";Não permitido;string;PIX; -/data/recurringConfiguration/automatic/immediatePayment/date;date;"Define a data alvo da liquidação do pagamento. +/data/recurringConfiguration/automatic/firstPayment/date;date;"Define a data alvo da liquidação do pagamento. O fuso horário de Brasília deve ser utilizado para criação e racionalização sobre os dados deste campo. ";Data;10;Obrigatório;^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?[1-9])$;;1;1;"";Não permitido;string;2021-01-01; -/data/recurringConfiguration/automatic/immediatePayment/currency;currency;"Código da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'. +/data/recurringConfiguration/automatic/firstPayment/currency;currency;"Código da moeda nacional segundo modelo ISO-4217, ou seja, 'BRL'. Todos os valores monetários informados estão representados com a moeda vigente do Brasil. ";Texto;3;Obrigatório;^([A-Z]{3})$;;1;1;"";Não permitido;string;BRL; -/data/recurringConfiguration/automatic/immediatePayment/amount;amount;"Valor da transação com 2 casas decimais. +/data/recurringConfiguration/automatic/firstPayment/amount;amount;"Valor da transação com 2 casas decimais. ";Texto;19;Obrigatório;^((\d{1,16}\.\d{2}))$;;1;1;"";Não permitido;string;100000.12;4 -/data/recurringConfiguration/automatic/immediatePayment/remittanceInformation;remittanceInformation;"Deve ser preenchido sempre que o usuário pagador inserir alguma informação adicional em um pagamento, a ser enviada ao recebedor. +/data/recurringConfiguration/automatic/firstPayment/remittanceInformation;remittanceInformation;"Deve ser preenchido sempre que o usuário pagador inserir alguma informação adicional em um pagamento, a ser enviada ao recebedor. ";Texto;140;Opcional;[\w\W\s]*;;0;1;"";Não permitido;string;Pagamento da nota RSTO035-002; -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount;creditorAccount;"Recebe os dados de conta do usuário recebedor. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount;creditorAccount;"Recebe os dados de conta do usuário recebedor. ";Objeto;;Obrigatório;;;1;1;"";Não permitido;object;; -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/ispb;ispb;"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantâneos) somente com números. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/ispb;ispb;"Deve ser preenchido com o ISPB (Identificador do Sistema de Pagamentos Brasileiros) do participante do SPI (Sistema de pagamentos instantâneos) somente com números. ";Texto;8;Obrigatório;^[0-9]{8}$;;1;1;"";Não permitido;string;12345678;8 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/issuer;issuer;"Código da Agência emissora da conta sem dígito. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/issuer;issuer;"Código da Agência emissora da conta sem dígito. (Agência é a dependência destinada ao atendimento aos clientes, ao público em geral e aos associados de cooperativas de crédito, no exercício de atividades da instituição, não podendo ser móvel ou transitória). [Restrição] Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA). ";Texto;4;Obrigatório;^[0-9]{1,4}$;;1;1;" Preenchimento obrigatório para os seguintes tipos de conta: CACC (CONTA_DEPOSITO_A_VISTA) e SVGS (CONTA_POUPANCA). ";Não permitido;string;1774;1 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/number;number;"Deve ser preenchido com o número da conta transacional do usuário pagador, com dígito verificador (se este existir), +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/number;number;"Deve ser preenchido com o número da conta transacional do usuário pagador, com dígito verificador (se este existir), se houver valor alfanumérico, este deve ser convertido para 0. ";Texto;20;Obrigatório;^[0-9]{1,20}$;;1;1;"";Não permitido;string;1234567890;1 -/data/recurringConfiguration/automatic/immediatePayment/creditorAccount/accountType;accountType;"Tipos de contas usadas para pagamento. +/data/recurringConfiguration/automatic/firstPayment/creditorAccount/accountType;accountType;"Tipos de contas usadas para pagamento. Modalidades tradicionais previstas pela Resolução 4.753, não contemplando contas vinculadas, conta de domiciliados no exterior, contas em moedas estrangeiras e conta correspondente moeda eletrônica. Segue descrição de cada valor do ENUM. diff --git a/swagger-apis/automatic-payments/2.0.0-beta.1.yml b/swagger-apis/automatic-payments/2.0.0-beta.1.yml index de09eceeb..d1e278834 100644 --- a/swagger-apis/automatic-payments/2.0.0-beta.1.yml +++ b/swagger-apis/automatic-payments/2.0.0-beta.1.yml @@ -137,9 +137,10 @@ info:  6.1.13 - Limite valor excedido por período: Foi atingido o valor limite permitido pelo usuário por um determinado período de tempo no consentimento do pagamento (LIMITE_PERIODO_VALOR_EXCEDIDO);  6.1.14 - Limite quantidade excedida por período: A quantidade de cobranças atingiu o limite determinado pelo usuário na criação do consentimento (LIMITE_PERIODO_QUANTIDADE_EXCEDIDO);  6.1.15 - Titularidade Inconsistente: Conta atualmente não associada ao CPF/CNPJ do consentimento de longa duração. Caso a liquidação seja negada pelo PSP Recebedor com erro BE01, cabe a detentora de conta mudar o status do pagamento para RJCT com essa reason (TITULARIDADE_INCONSISTENTE); -  6.1.16 - Limite global excedido: O consentimento encontrasse autorizado e o valor solicitado para cobrança ultrapassa a faixa de limite global parametrizado pelo usuário durante a criação do consentimento (LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO); -  6.1.17 - Limite de transação excedido: O consentimento encontra-se autorizado e o valor solicitado para cobrança ultrapassa a faixa de limite de valor por transação parametrizado pelo usuário na criação do consentimento (LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO); -  6.1.18 Limite de retentativas atingido: Valida se todas as tentativas de liquidação permitidas já foram realizadas (LIMITE_TENTATIVA_EXCEDIDO). +  6.1.16 - Consentimento revogado: O pagamento estava associado a um consentimento que foi revogado (CONSENTIMENTO_REVOGADO); +  6.1.17 - Limite global excedido: O consentimento encontrasse autorizado e o valor solicitado para cobrança ultrapassa a faixa de limite global parametrizado pelo usuário durante a criação do consentimento (LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO); +  6.1.18 - Limite de transação excedido: O consentimento encontra-se autorizado e o valor solicitado para cobrança ultrapassa a faixa de limite de valor por transação parametrizado pelo usuário na criação do consentimento (LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO); +  6.1.19 Limite de retentativas atingido: Valida se todas as tentativas de liquidação permitidas já foram realizadas (LIMITE_TENTATIVA_EXCEDIDO). ## Validações antifraude da Transferências Inteligentes @@ -1582,6 +1583,16 @@ components: [Restrições] Este campo é de preenchimento obrigatório pela detentora quando for uma tentativa de pagamento com erro ou falha. Este campo é de envio obrigatório pela iniciadora quando for uma tentativa de pagamento que falhou anteriormente. + items: + type: string + minLength: 1 + maxLength: 100 + pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$ + example: TXpRMU9UQTROMWhZV2xSU1FUazJSMDl + description: | + Código ou identificador único informado pela instituição detentora da conta para representar a iniciação de pagamento. + O recurringPaymentId deve ser diferente do endToEndId. + Este é o identificador que deverá ser utilizado na consulta ao status da iniciação de pagamento efetuada. EndToEndId: type: string minLength: 32 @@ -1725,6 +1736,7 @@ components: - TITULARIDADE_INCONSISTENTE - LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO - LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO + - CONSENTIMENTO_REVOGADO example: SALDO_INSUFICIENTE description: | Código identificador do motivo de rejeição. @@ -1746,6 +1758,7 @@ components: - 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 [Restrição] Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). EnumRejectionReasonCode: @@ -1769,6 +1782,7 @@ components: - LIMITE_VALOR_TOTAL_CONSENTIMENTO_EXCEDIDO - LIMITE_VALOR_TRANSACAO_CONSENTIMENTO_EXCEDIDO - LIMITE_TENTATIVAS_EXCEDIDO + - CONSENTIMENTO_REVOGADO example: SALDO_INSUFICIENTE description: | Código identificador do motivo de rejeição. @@ -1791,6 +1805,7 @@ components: - 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: O máximo de tentativas de liquidação permitidas pelo arranjo foi atingido. + - CONSENTIMENTO_REVOGADO [Restrição] Esse motivo deverá ser enviado quando o campo `/data/status` for igual a RJCT (REJECTED). EnumPaymentCancellationReasonType: @@ -1984,6 +1999,7 @@ components: - 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. RejectionReason: type: object description: | @@ -2019,6 +2035,7 @@ components: - 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. + - CONSENTIMENTO_REVOGADO: O pagamento estava associado a um consentimento que foi revogado. ConsentEdition: type: object properties: @@ -2073,16 +2090,6 @@ components: Valor máximo permitido por cobrança, caso preenchido, representa um consentimento para pagamentos de valores variáveis. [Restrição] Excludente com o campo “/data/recurringConfiguration/automatic/fixedAmount” - dayOfMonth: - description: | - Dia fixo do mês que está prevista a transação. Caso consentimento seja para pagamentos trimestrais ou semestrais, o campo representa o dia do mês selecionado no campo `/data/recurringConfiguration/automatic/month` em que ocorrerá primeira cobrança. - - [Restrição] Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL. - type: integer - format: int32 - minimum: 1 - maximum: 31 - example: 10 ConsentRevocation: type: object properties: @@ -2220,38 +2227,6 @@ components: - ANUAL - SEMESTRAL - TRIMESTRAL - dayOfMonth: - type: integer - format: int32 - minimum: 1 - maximum: 31 - example: 10 - description: | - Dia fixo do mês que está prevista a transação. Caso consentimento seja para pagamentos trimestrais ou semestrais, o campo representa o dia do mês selecionado no campo `/data/recurringConfiguration/automatic/month` em que ocorrerá primeira cobrança. - - [Restrição] Campo deve ser enviado quando o campo /data/recurringConfiguration/automatic/period for igual a MENSAL, TRIMESTRAL, SEMESTRAL ou ANUAL. - dayOfWeek: - type: string - enum: - - SEGUNDA_FEIRA - - TERCA_FEIRA - - QUARTA_FEIRA - - QUINTA_FEIRA - - SEXTA_FEIRA - - SABADO - - DOMINGO - example: 'SEGUNDA_FEIRA' - description: | - Dia da semana que está prevista a transação. - - SEGUNDA_FEIRA - - TERCA_FEIRA - - QUARTA_FEIRA - - QUINTA_FEIRA - - SEXTA_FEIRA - - SABADO - - DOMINGO - - [Restrição] Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a SEMANAL. month: type: string enum: @@ -2286,8 +2261,8 @@ components: [Restrição] Campo deve ser enviado quando o campo `/data/recurringConfiguration/automatic/period` for igual a TRIMESTRAL, SEMESTRAL ou ANUAL contractDebtor: $ref: '#/components/schemas/ContractDebtor' - immediatePayment: - $ref: '#/components/schemas/ImmediatePayment' + firstPayment: + $ref: '#/components/schemas/FirstPayment' minimumVariableAmount: type: string pattern: ^((\d{1,16}\.\d{2}))$ @@ -2333,9 +2308,14 @@ components: description: Tipo do documento de identificação oficial do cliente devedor do contrato. example: CNPJ pattern: '^[A-Z]{4}$' - ImmediatePayment: + FirstPayment: type: object - description: Definições para transação imediata. + description: | + Definições para o primeiro pagamento. É considerado como o pagamento da adesão ao serviço pelo usuário pagador. + + - A conta de crédito informada deve pertencer ao mesmo CNPJ informado no campo “/data/creditors/cpfCnpj” + - A conta de crédito informada no momento do primeiro pagamento deve ser a mesma informada dentro deste objeto. + Caso não respeitado, o detentor deve rejeitar o pagamento com o motivo DETALHE_PAGAMENTO_INVALIDO, sincronamente (HTTP 422) ou assincronamente (HTTP 200) required: - type - date