Merge pull request #4545 from Sensedia/aggr-automatic-payments

feat(automatic payments): EOF-471 - PSV-261 - Proposta para criar o c…
Sensedia · Oct 8, 2024 · a60620d · a60620d
2 parents 4bc44c8 + 017ea62
commit a60620d
Show file tree

Hide file tree

Showing 4 changed files with 117 additions and 1 deletion.
diff --git a/dictionary/automaticPaymentsGetRecurringConsentsConsentId_v2.csv b/dictionary/automaticPaymentsGetRecurringConsentsConsentId_v2.csv
@@ -271,6 +271,7 @@ Se o usuário pagador atribuir um valor máximo para os pagamentos daquela autor
 Não pode ser preenchido nas autorizações de valor fixo.
 ";Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;100000.12;4
 /data/recurringConfiguration/automatic/isRetryAccepted;isRetryAccepted;Indica se é permitido pelo cliente recebedor fazer tentativas de pagamento (extradia), conforme as regras estabelecidas no arranjo Pix.;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;false;
+/data/recurringConfiguration/automatic/useOverdraftLimit;useOverdraftLimit;Indica se o usuário pagador autorizou a utilização de limite pré-aprovado (cheque especial) na sua conta para realização de pagamentos, caso o cliente possua o produto.;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
 /data/recurringConfiguration/sweeping;sweeping;Definição da configuração de recorrência para transferências automáticas de fundos.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/recurringConfiguration/sweeping/totalAllowedAmount;totalAllowedAmount;Valor máximo a ser atingido pelo somatório de todas as transações que utilizam o consentimento autorizado pelo cliente. Caso o valor seja superado, a detentora de conta deve negar a transação solicitada pela iniciadora.;Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;100000.12;4
 /data/recurringConfiguration/sweeping/transactionLimit;transactionLimit;Valor máximo para cada transação de pagamento associada a esse consentimento. Caso valor do pagamento seja maior que esse limite, a detentora de contas deve rejeitar a transação de pagamento.;Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;1000000.12;4

diff --git a/dictionary/automaticPaymentsPatchRecurringConsentsConsentId_v2.csv b/dictionary/automaticPaymentsPatchRecurringConsentsConsentId_v2.csv
@@ -271,6 +271,7 @@ Se o usuário pagador atribuir um valor máximo para os pagamentos daquela autor
 Não pode ser preenchido nas autorizações de valor fixo.
 ";Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;100000.12;4
 /data/recurringConfiguration/automatic/isRetryAccepted;isRetryAccepted;Indica se é permitido pelo cliente recebedor fazer tentativas de pagamento (extradia), conforme as regras estabelecidas no arranjo Pix.;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;false;
+/data/recurringConfiguration/automatic/useOverdraftLimit;useOverdraftLimit;Indica se o usuário pagador autorizou a utilização de limite pré-aprovado (cheque especial) na sua conta para realização de pagamentos, caso o cliente possua o produto.;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
 /data/recurringConfiguration/sweeping;sweeping;Definição da configuração de recorrência para transferências automáticas de fundos.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/recurringConfiguration/sweeping/totalAllowedAmount;totalAllowedAmount;Valor máximo a ser atingido pelo somatório de todas as transações que utilizam o consentimento autorizado pelo cliente. Caso o valor seja superado, a detentora de conta deve negar a transação solicitada pela iniciadora.;Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;100000.12;4
 /data/recurringConfiguration/sweeping/transactionLimit;transactionLimit;Valor máximo para cada transação de pagamento associada a esse consentimento. Caso valor do pagamento seja maior que esse limite, a detentora de contas deve rejeitar a transação de pagamento.;Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;1000000.12;4

diff --git a/dictionary/automaticPaymentsPostRecurringConsents_v2.csv b/dictionary/automaticPaymentsPostRecurringConsents_v2.csv
@@ -274,6 +274,7 @@ Se o usuário pagador atribuir um valor máximo para os pagamentos daquela autor
 Não pode ser preenchido nas autorizações de valor fixo.
 ";Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;100000.12;4
 /data/recurringConfiguration/automatic/isRetryAccepted;isRetryAccepted;Indica se é permitido pelo cliente recebedor fazer tentativas de pagamento (extradia), conforme as regras estabelecidas no arranjo Pix.;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;false;
+/data/recurringConfiguration/automatic/useOverdraftLimit;useOverdraftLimit;Indica se o usuário pagador autorizou a utilização de limite pré-aprovado (cheque especial) na sua conta para realização de pagamentos, caso o cliente possua o produto.;Booleano;;Obrigatório;;;1;1;"";Não permitido;boolean;true;
 /data/recurringConfiguration/sweeping;sweeping;Definição da configuração de recorrência para transferências automáticas de fundos.;Objeto;;Obrigatório;;;1;1;"";Não permitido;object;;
 /data/recurringConfiguration/sweeping/totalAllowedAmount;totalAllowedAmount;Valor máximo a ser atingido pelo somatório de todas as transações que utilizam o consentimento autorizado pelo cliente. Caso o valor seja superado, a detentora de conta deve negar a transação solicitada pela iniciadora.;Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;100000.12;4
 /data/recurringConfiguration/sweeping/transactionLimit;transactionLimit;Valor máximo para cada transação de pagamento associada a esse consentimento. Caso valor do pagamento seja maior que esse limite, a detentora de contas deve rejeitar a transação de pagamento.;Texto;19;Opcional;^((\d{1,16}\.\d{2}))$;;0;1;"";Não permitido;string;1000000.12;4

diff --git a/swagger-apis/automatic-payments/2.0.0-beta.1.yml b/swagger-apis/automatic-payments/2.0.0-beta.1.yml
@@ -956,7 +956,7 @@ components:
               type: object
               description: Campo destinado a configuração dos diferentes produtos de pagamentos recorrentes.
               oneOf:
-                - $ref: '#/components/schemas/Automatic'
+                - $ref: '#/components/schemas/AutomaticRequest'
                 - $ref: '#/components/schemas/SweepingRequest'
                 - $ref: '#/components/schemas/Vrp'
     CreateRecurringPixPayment:
@@ -2169,6 +2169,113 @@ components:
         - $ref: '#/components/schemas/Automatic'
         - $ref: '#/components/schemas/Sweeping'
         - $ref: '#/components/schemas/Vrp'
+    AutomaticRequest: 
+      type: object
+      required:
+        - automatic
+      properties:
+        automatic:
+          type: object
+          description: Definição da configuração de recorrência para pagamentos automáticos
+          required:
+            - contractId
+            - period
+            - contractDebtor
+            - isRetryAccepted
+          properties:
+            contractId:
+              type: string
+              pattern: '^[a-zA-Z0-9]{1,35}$'
+              minLength: 1
+              maxLength: 35
+              example: XE00038166201907261559y6j6
+              description: Identificador do contrato de transação
+            fixedAmount:
+              type: string
+              pattern: '^((\d{1,16}\.\d{2}))$'
+              minLength: 4
+              maxLength: 19
+              example: '100000.12'
+              description: |
+                Valor fixo de cobrança, caso preenchido, representa um consentimento para pagamentos de valores fixos, ou não sujeitos a alteração durante a vigência do consentimento. 
+                
+                [Restrição] Excludente com o campo “/data/recurringConfiguration/automatic/maximumVariableAmount”
+            maximumVariableAmount:
+              type: string
+              pattern: '^((\d{1,16}\.\d{2}))$'
+              minLength: 4
+              maxLength: 19
+              example: '1000000.12'
+              description: |
+                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”
+            period:
+              type: string
+              enum:
+                - SEMANAL
+                - MENSAL
+                - ANUAL
+                - SEMESTRAL
+                - TRIMESTRAL
+              example: SEMANAL
+              description: |
+                Define a periodicidade permitida para realização de transações
+                - SEMANAL
+                - MENSAL
+                - ANUAL
+                - SEMESTRAL
+                - TRIMESTRAL
+            month:
+              type: string
+              enum:
+                - JANEIRO
+                - FEVEREIRO
+                - MARCO
+                - ABRIL
+                - MAIO
+                - JUNHO
+                - JULHO
+                - AGOSTO
+                - SETEMBRO
+                - OUTUBRO
+                - NOVEMBRO
+                - DEZEMBRO
+              example: 'JANEIRO'
+              description: |
+                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
+                - MARCO
+                - ABRIL
+                - MAIO
+                - JUNHO
+                - JULHO
+                - AGOSTO
+                - SETEMBRO
+                - OUTUBRO
+                - NOVEMBRO
+                - DEZEMBRO
+
+                [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'
+            firstPayment:
+              $ref: '#/components/schemas/FirstPayment'
+            minimumVariableAmount:
+              type: string
+              pattern: ^((\d{1,16}\.\d{2}))$
+              minLength: 4
+              maxLength: 19
+              example: '100000.12'
+              description: |
+                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 valor mínimo (piso) definido pelo usuário recebedor. 
+                Não pode ser preenchido nas autorizações de valor fixo.
+            isRetryAccepted:
+              type: boolean
+              description: Indica se é permitido pelo cliente recebedor fazer tentativas de pagamento (extradia), conforme as regras estabelecidas no arranjo Pix.
+              example: false
     Automatic:
       type: object
       required:
@@ -2182,6 +2289,7 @@ components:
             - period
             - contractDebtor
             - isRetryAccepted
+            - useOverdraftLimit
           properties:
             contractId:
               type: string
@@ -2276,6 +2384,11 @@ components:
               type: boolean
               description: Indica se é permitido pelo cliente recebedor fazer tentativas de pagamento (extradia), conforme as regras estabelecidas no arranjo Pix.
               example: false
+            useOverdraftLimit:
+              type: boolean
+              default: true
+              example: true
+              description: Indica se o usuário pagador autorizou a utilização de limite pré-aprovado (cheque especial) na sua conta para realização de pagamentos, caso o cliente possua o produto.
     ContractDebtor:
       type: object
       description: Informações sobre o cliente devedor do contrato.