diff --git a/swagger-apis/products-services/2.0.0-beta.1.yml b/swagger-apis/products-services/2.0.0-beta.1.yml index b97f28eb2..1ededb183 100644 --- a/swagger-apis/products-services/2.0.0-beta.1.yml +++ b/swagger-apis/products-services/2.0.0-beta.1.yml @@ -1382,28 +1382,33 @@ components: example: PRE_FIXADO rate: type: string - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' + pattern: '^\d{1}\.\d{6}$' description: | Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%) A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.1500' - maxLength: 6 + example: '0.150000' + minLength: 8 + maxLength: 8 applications: type: array items: - $ref: '#/components/schemas/LoansFinancingsInvoiceFinancingsApplicationRate' + $ref: '#/components/schemas/ApplicationRate' minItems: 4 maxItems: 4 description: Lista das faixas de cobrança da taxa efetiva aplicada pela contratação de crédito minimumRate: type: string - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' + pattern: '^\d{1}\.\d{6}$' + minLength: 8 + maxLength: 8 description: 'Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Empréstimo contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - example: '0.0456' + example: '0.045600' maximumRate: type: string - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' + pattern: '^\d{1}\.\d{6}$' + minLength: 8 + maxLength: 8 description: 'Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Empréstimo contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - example: '0.6865' + example: '0.686500' ApplicationRate: type: object properties: @@ -1417,19 +1422,6 @@ components: - interval - indexer - customers - LoansFinancingsInvoiceFinancingsApplicationRate: - type: object - properties: - interval: - $ref: '#/components/schemas/ApplicationIntervals' - indexer: - $ref: '#/components/schemas/LoansFinancingsInvoiceFinancingsIndexer' - customers: - $ref: '#/components/schemas/LoansFinancingsInvoiceFinancingsCustomer' - required: - - interval - - indexer - - customers Indexer: type: object properties: @@ -1441,16 +1433,6 @@ components: description: | Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do crédito, no intervalo informado. p.ex. '0,8700%'. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) example: '0.870000' - LoansFinancingsInvoiceFinancingsIndexer: - type: object - properties: - rate: - type: string - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' - maxLength: 6 - description: | - Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do crédito, no intervalo informado. p.ex. '0,8700%'. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.8700' PriceIntervals: type: string enum: @@ -2080,47 +2062,53 @@ components: example: PRE_FIXADO rate: type: string - pattern: '(^[0-9](\.[0-9]{2})|NA)$' + pattern: '^\d{1}\.\d{6}$' description: | Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%) A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.15' + example: '0.150000' + minLength: 8 + maxLength: 8 applications: type: array items: - $ref: '#/components/schemas/LoansFinancingsInvoiceFinancingsApplicationRate' + $ref: '#/components/schemas/ApplicationRate' minItems: 4 maxItems: 4 example: - interval: 1_FAIXA indexer: - rate: '0.0987' + rate: '0.098700' customers: - rate: '0.15' + rate: '0.150000' - interval: 2_FAIXA indexer: - rate: '0.1600' + rate: '0.160000' customers: - rate: '0.35' + rate: '0.350000' - interval: 3_FAIXA indexer: - rate: '0.3600' + rate: '0.360000' customers: - rate: '0.20' + rate: '0.200000' - interval: 4_FAIXA indexer: - rate: '0.5890' + rate: '0.589000' customers: - rate: '0.30' + rate: '0.300000' minimumRate: type: string - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' + pattern: '^\d{1}\.\d{6}$' description: 'Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - example: '0.0456' + example: '0.045600' + minLength: 8 + maxLength: 8 maximumRate: type: string - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' + pattern: '^\d{1}\.\d{6}$' description: 'Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - example: '0.6865' + example: '0.686500' + minLength: 8 + maxLength: 8 ResponseBusinessFinancings: type: object required: @@ -2441,29 +2429,35 @@ components: example: PRE_FIXADO rate: type: string - pattern: '(^[0-9](\.[0-9]{2})|NA)$' + pattern: '^\d{1}\.\d{6}$' description: | Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%) A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.15' + example: '0.150000' + minLength: 8 + maxLength: 8 applications: type: array description: Lista das faixas de cobrança da taxa efetiva de remuneração items: - $ref: "#/components/schemas/LoansFinancingsInvoiceFinancingsApplicationRate" + $ref: "#/components/schemas/ApplicationRate" minItems: 4 maxItems: 4 minimumRate: type: string description: | Percentual mínimo cobrado (taxa efetiva) no mês de referência, para os Direitos Creditórios Descontados contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.15. Este valor representa 15%. O valor 1 representa 100%) - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' - example: '0.0889' + pattern: '^\d{1}\.\d{6}$' + minLength: 8 + maxLength: 8 + example: '0.088900' maximumRate: type: string description: | Percentual máximo cobrado (taxa efetiva) no mês de referência, para os Direitos Creditórios Descontados contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.15. Este valor representa 15%. O valor 1 representa 100%) - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' - example: '0.6865' + pattern: '^\d{1}\.\d{6}$' + minLength: 8 + maxLength: 8 + example: '0.686500' ResponseBusinessInvoiceFinancings: type: object required: @@ -2620,29 +2614,35 @@ components: example: PRE_FIXADO rate: type: string - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' + pattern: '^\d{1}\.\d{6}$' description: | Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%) A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.1500' + example: '0.150000' + minLength: 8 + maxLength: 8 applications: type: array description: Lista das faixas de cobrança da taxa efetiva de remuneração items: - $ref: "#/components/schemas/LoansFinancingsInvoiceFinancingsApplicationRate" + $ref: "#/components/schemas/ApplicationRate" minItems: 4 maxItems: 4 minimumRate: type: string description: | Percentual mínimo cobrado (taxa efetiva) no mês de referência, para os Direitos Creditórios Descontados contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.15. Este valor representa 15%. O valor 1 representa 100%) - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' - example: '0.1500' + pattern: '^\d{1}\.\d{6}$' + minLength: 8 + maxLength: 8 + example: '0.150000' maximumRate: type: string description: | Percentual máximo cobrado (taxa efetiva) no mês de referência, para os Direitos Creditórios Descontados contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.15. Este valor representa 15%. O valor 1 representa 100%) - pattern: '(^[0-9](\.[0-9]{4})$|^NA$)' - example: '0.6865' + pattern: '^\d{1}\.\d{6}$' + minLength: 8 + maxLength: 8 + example: '0.686500' ResponseBusinessUnarrangedAccountOverdraft: type: object required: @@ -3082,18 +3082,6 @@ components: example: '8800.00' currency: $ref: "#/components/schemas/Currency" - LoansFinancingsInvoiceFinancingsCustomer: - type: object - required: - - rate - properties: - rate: - type: string - description: | - Percentual de clientes em cada faixa. - pattern: '(^[0-1](\.[0-9]{2})$|^NA$)' - example: '0.15' - maxLength: 6 Customer: type: object required: diff --git a/swagger-apis/products-services/index.html b/swagger-apis/products-services/index.html index 7961da8f0..10db86bef 100644 --- a/swagger-apis/products-services/index.html +++ b/swagger-apis/products-services/index.html @@ -51,9 +51,8 @@ {"name": "1.0.0", "url": "./1.0.0.yml"}, {"name": "1.0.1", "url": "./1.0.1.yml"}, {"name": "1.0.2", "url": "./1.0.2.yml"}, - {"name": "2.0.0-beta.1", "url": "./2.0.0-beta.1.yml"}, - {"name": "y.y.y", "url": "./y.y.y.yml"}], - "urls.primaryName": "y.y.y", // default spec + {"name": "2.0.0-beta.1", "url": "./2.0.0-beta.1.yml"}], + "urls.primaryName": "2.0.0-beta.1", // default spec dom_id: '#swagger-ui', deepLinking: true, supportedSubmitMethods:[], diff --git a/swagger-apis/products-services/y.y.y.yml b/swagger-apis/products-services/y.y.y.yml deleted file mode 100644 index 6e169b4ce..000000000 --- a/swagger-apis/products-services/y.y.y.yml +++ /dev/null @@ -1,3465 +0,0 @@ -openapi: 3.0.0 -info: - title: API's OpenData do Open Finance Brasil - description: As API's descritas neste documento são referentes as API's da fase OpenData do Open Finance Brasil. - version: y.y.y - contact: - url: 'https://servicedesk.openbankingbrasil.org.br/Login.jsp?navLanguage=pt-BR' -servers: - - url: 'http://api.banco.com.br/open-banking/products-services/v1' -tags: - - name: Accounts - - name: Loans - - name: Credit Cards - - name: Financings - - name: Invoice Financings - - name: Unarranged Account Overdraft -paths: - /personal-accounts: - get: - tags: - - Accounts - summary: Obtém dados das contas pessoa natural - description: Obtém dados das contas - operationId: getPersonalAccounts - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Dados sobre contas pessoa natural obtidos com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponsePersonalAccounts' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /business-accounts: - get: - tags: - - Accounts - summary: Obtém dados das contas pessoa jurídica - description: Obtém dados das contas pessoa jurídica - operationId: getBusinessAccounts - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Dados sobre contas pessoa jurídica obtidos com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseBusinessAccounts' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /personal-loans: - get: - tags: - - Loans - summary: Obtém dados sobre empréstimos pessoa natural - description: Obtém dados sobre empréstimos pessoa natural - operationId: getPersonalLoans - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Dados sobre empréstimos pessoa natural obtidos com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponsePersonalLoans' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /business-loans: - get: - tags: - - Loans - summary: Obtém dados sobre empréstimos pessoa jurídica - description: Obtém dados sobre empréstimos pessoa jurídica - operationId: getBusinessLoans - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Dados sobre empréstimos pessoa jurídica obtidos com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseBusinessLoans' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /personal-credit-cards: - get: - tags: - - Credit Cards - summary: Obtém dados sobre cartões de crédito pessoa natural - description: Obtém dados sobre cartões de crédito pessoa natural - operationId: getPersonalCreditCards - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Dados sobre cartão de crédito pessoa natural obtidos com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/PersonalCreditCardResponse' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /business-credit-cards: - get: - tags: - - Credit Cards - summary: Obtém dados sobre cartões de crédito pessoa jurídica - description: Obtém dados sobre cartões de crédito pessoa jurídica - operationId: getBusinessCreditCards - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Dados sobre cartões de crédito pessoa jurídica obtidos com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/BusinessCreditCardResponse' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /personal-financings: - get: - tags: - - Financings - summary: Obtém a lista de Financiamentos de Pessoa Natural. - description: Obtém a lista de Financiamentos de Pessoa Natural - operationId: getPersonalFinancings - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Lista de financiamentos de pessoa natural obtida com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponsePersonalFinancings' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /business-financings: - get: - tags: - - Financings - summary: Obtém a lista de Financiamentos de Pessoa Jurídica. - description: Obtém a lista de Financiamentos de Pessoa Jurídica. - operationId: getBusinessFinancings - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Lista de financiamentos de pessoa jurídica obtida com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseBusinessFinancings' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /personal-invoice-financings: - get: - tags: - - Invoice Financings - summary: Obtém a lista de Adiantamento de Recebíveis de Pessoa Natural. - description: Obtém a lista de Adiantamento de Recebíveis de Pessoa Natural. - operationId: getPersonalInvoiceFinancings - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Lista de adiantamento de recebíveis de pessoa natural obtida com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponsePersonalInvoiceFinancings' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /business-invoice-financings: - get: - tags: - - Invoice Financings - summary: Obtém a lista de Adiantamento de Recebíveis de Pessoa Jurídica. - description: Obtém a lista de Adiantamento de Recebíveis de Pessoa Jurídica. - operationId: getBusinessInvoiceFinancings - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Lista de adiantamento de recebíveis de pessoa jurídica obtida com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseBusinessInvoiceFinancings' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /personal-unarranged-account-overdraft: - get: - tags: - - Unarranged Account Overdraft - summary: Obtém a lista de adiantamento de depositante de Pessoa Natural. - description: Obtém a lista de adiantamento de depositante de Pessoa Natural. - operationId: getPersonalUnarrangedAccountOverdraft - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Lista de adiantamento de depositante de pessoa natural obtida com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponsePersonalUnarrangedAccountOverdraft' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' - /business-unarranged-account-overdraft: - get: - tags: - - Unarranged Account Overdraft - summary: Obtém a lista de adiantamento de depositante de Pessoa Jurídica. - description: Obtém a lista de adiantamento de depositante de Pessoa Jurídica. - operationId: getBusinessUnarrangedAccountOverdraft - parameters: - - $ref: "#/components/parameters/page" - - $ref: "#/components/parameters/pageSize" - responses: - '200': - description: Lista de adiantamento de depositante de pessoa jurídica obtida com sucesso. - content: - application/json: - schema: - $ref: '#/components/schemas/ResponseBusinessUnarrangedAccountOverdraft' - '400': - $ref: '#/components/responses/BadRequest' - '404': - $ref: '#/components/responses/NotFound' - '405': - $ref: '#/components/responses/MethodNotAllowed' - '429': - $ref: '#/components/responses/TooManyRequests' - '500': - $ref: '#/components/responses/InternalServerError' - '504': - $ref: '#/components/responses/GatewayTimeout' - '529': - $ref: '#/components/responses/SiteIsOverloaded' - default: - $ref: '#/components/responses/Default' -components: - schemas: - AccountsTermsConditions: - type: object - description: Objeto que reúne informações relativas a Termos e Condições para as modalidades tratadas - required: - - minimumBalance - - elegibilityCriteriaInfo - - closingProcessInfo - properties: - minimumBalance: - $ref: '#/components/schemas/MinimumBalance' - elegibilityCriteriaInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: 'Critérios de qualificação do cliente com a finalidade de definir sua elegibilidade para a aquisição do tipo de conta. Campo Aberto' - example: 'https://example.com/mobile-banking' - closingProcessInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: 'Procedimentos de encerramento para o tipo de conta tratado. Possibilidade de inscrição da URL. Endereço eletrônico de acesso ao canal. p.ex. ''https://example.com/mobile-banking'' ' - example: 'https://example.com/mobile-banking' - ResponsePersonalAccounts: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/PersonalAccountBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - PersonalAccountBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - maxLength: 80 - pattern: '[\w\W\s]*' - description: 'Nome da Marca reportada pelo participante do Open Finance. O conceito a que se refere a ''marca'' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes' - example: Organização A - companies: - type: array - maxItems: 700 - description: 'Companies traz uma lista de todas as instituições da Marca' - items: - $ref: '#/components/schemas/PersonalAccountCompany' - minItems: 1 - PersonalAccountCompany: - type: object - required: - - name - - cnpjNumber - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - personalAccounts: - type: array - items: - $ref: '#/components/schemas/PersonalAccount' - description: Lista de tipos de conta - minItems: 1 - maxItems: 3 - PersonalAccount: - type: object - required: - - type - - fees - - openingClosingChannels - - transactionMethods - - termsConditions - properties: - type: - $ref: '#/components/schemas/AccountType' - fees: - $ref: '#/components/schemas/AccountFee' - serviceBundles: - type: array - items: - $ref: '#/components/schemas/PersonalAccountServiceBundle' - minItems: 1 - maxItems: 200 - description: | - Lista dos Pacotes de serviços - - [Restrição] - - Caso o ENUM do campo “type” seja CONTA_PAGAMENTO_PRE_PAGA a estrutura “serviceBundle” fica condicionado caso a instituição tenha pacote de serviço - atrelado a este tipo de conta, porque são contas com serviços essenciais padronizados e regulados pela Resolução BACEN 3919, de 25/11/2010 - - - Caso o ENUM do campo “type” seja CONTA_DEPOSITO_A_VISTA (conta corrente) ou CONTA_POUPANCA, deverá ser incluso a estrutura “serviceBundle”, porque - existem hoje pacotes passíveis de cobrança diferentes dos serviços essenciais (que não são cobrados) - openingClosingChannels: - type: array - items: - $ref: '#/components/schemas/OpeningClosingChannels' - minItems: 1 - maxItems: 7 - description: Lista dos canais para aberturas e encerramento - additionalInfo: - type: string - maxLength: 100 - pattern: '[\w\W\s]*' - description: | - Texto livre para complementar informação relativa ao Canal disponível, quando no campo ''openingClosingChannels'' estiver preenchida a opção ''Outros'' - Restrição: Campo de preenchimento obrigatório se ''openingCloseChannels'' estiver preenchida a opção ''OUTROS'' - example: 'NA' - transactionMethods: - type: array - items: - $ref: '#/components/schemas/TransactionMethods' - minItems: 1 - maxItems: 4 - description: Lista de formas de movimentação - termsConditions: - $ref: '#/components/schemas/AccountsTermsConditions' - incomeRate: - $ref: '#/components/schemas/AccountsIncomeRate' - AccountFee: - type: object - description: Objeto que reúne informações de tarifas de serviços - required: - - priorityServices - properties: - priorityServices: - type: array - items: - $ref: '#/components/schemas/AccountPriorityService' - minItems: 1 - maxItems: 40 - description: Lista das Tarifas cobradas sobre Serviços Prioritários - otherServices: - type: array - items: - $ref: '#/components/schemas/AccountOtherService' - minItems: 1 - maxItems: 100 - description: Lista das Tarifas cobradas sobre outros Serviços, que não prioritários - AccountPriorityService: - type: object - required: - - name - - code - - chargingTriggerInfo - - prices - - minimum - - maximum - properties: - name: - $ref: '#/components/schemas/PriorityServiceName' - code: - $ref: '#/components/schemas/AccountPriorityServiceCode' - chargingTriggerInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: 'Fatos geradores de cobrança que incidem sobre os serviços prioritários, segundo Resolução 3.919 do Bacen, para pessoa natural.' - example: 'Fornecimento de extrato com a movimentação de um período em guichê de caixa ou por outras formas de atendimento pessoal, tal como atendimento telefônico realizado por atendente.' - prices: - type: array - items: - $ref: '#/components/schemas/PersonalAccountPrice' - minItems: 4 - maxItems: 4 - description: Lista distribuição preços tarifas de serviços - minimum: - $ref: '#/components/schemas/MinimumPrice' - maximum: - $ref: "#/components/schemas/MaximumPrice" - AccountType: - type: string - enum: - - CONTA_DEPOSITO_A_VISTA - - CONTA_POUPANCA - - CONTA_PAGAMENTO_PRE_PAGA - description: | - Tipos de contas ofertadas para pessoa natural ou jurídica, p.ex. 'CONTA_DEPOSITO_A_VISTA'. - Conta de depósito à vista ou Conta corrente - é o tipo mais comum. Nela, o dinheiro fica à sua disposição para ser sacado a qualquer momento. Essa conta não gera rendimentos para o depositante - Conta poupança - foi criada para estimular as pessoas a pouparem. O dinheiro que ficar na conta por trinta dias passa a gerar rendimentos, com isenção de imposto de renda para quem declara. Ou seja, o dinheiro “cresce” (rende) enquanto ficar guardado na conta. Cada depósito terá rendimentos de mês em mês, sempre no dia do mês em que o dinheiro tiver sido depositado - Conta de pagamento pré-paga: segundo CIRCULAR Nº 3.680, BCB de 2013, é a 'destinada à execução de transações de pagamento em moeda eletrônica realizadas com base em fundos denominados em reais previamente aportados' - example: CONTA_DEPOSITO_A_VISTA - OpeningClosingChannels: - type: string - enum: - - DEPENDENCIAS_PROPRIAS - - CORRESPONDENTES_BANCARIOS - - INTERNET_BANKING - - MOBILE_BANKING - - CENTRAL_TELEFONICA - - CHAT - - OUTROS - description: Canais disponíveis para abertura e encerramento de contas, p.ex. 'DEPENDENCIAS_PROPRIAS' - example: DEPENDENCIAS_PROPRIAS - TransactionMethods: - type: string - enum: - - MOVIMENTACAO_ELETRONICA - - MOVIMENTACAO_CHEQUE - - MOVIMENTACAO_CARTAO - - MOVIMENTACAO_PRESENCIAL - description: Lista de formas de movimentação possíveis para a conta - example: MOVIMENTACAO_CARTAO - PriorityServiceName: - type: string - enum: - - CONFECCAO_CADASTRO_INICIO_RELACIONAMENTO - - FORNECIMENTO_2_VIA_CARTAO_FUNCAO_DEBITO - - FORNECIMENTO_2_VIA_CARTAO_FUNCAO_MOVIMENTACAO_CONTA_POUPANCA - - EXCLUSAO_CADASTRO_EMITENTES_CHEQUES_SEM_FUNDO_CCF - - CONTRA_ORDEM_REVOGACAO_E_OPOSICAO_OU_SUSTACAO_PAGAMENTO_CHEQUE - - FORNECIMENTO_FOLHAS_CHEQUE - - CHEQUE_ADMINISTRATIVO - - CHEQUE_VISADO - - SAQUE_CONTA_DEPOSITO_A_VISTA_POUPANCA_PRESENCIAL_OU_PESSOAL - - SAQUE_CONTA_DEPOSITO_A_VISTA_POUPANCA_TERMINAL_AUTOATENDIMENTO - - SAQUE_CONTA_DEPOSITO_A_VISTA_POUPANCA_CORRESPONDENTES_PAIS - - DEPOSITO_IDENTIFICADO - - FORNECIMENTO_EXTRATO_MENSAL_CONTA_DEPOSITOS_A_VISTA_E_POUPANCA_PRESENCIAL_OU_PESSOAL - - FORNECIMENTO_EXTRATO_MENSAL_CONTA_DEPOSITOS_A_VISTA_E_POUPANCA_TERMINAL_AUTOATENDIMENTO - - FORNECIMENTO_EXTRATO_MENSAL_CONTA_DEPOSITOS_A_VISTA_E_POUPANCA_CORRESPONDENTES_PAIS - - FORNECIMENTO_EXTRATO_DE_UM_PERIODO_CONTA_DEPOSITOS_A_VISTA_E_POUPANCA_PRESENCIAL_OU_PESSOAL - - FORNECIMENTO_EXTRATO_DE_UM_PERIODO_CONTA_DEPOSITOS_A_VISTA_E_POUPANCA_TERMINAL_AUTOATENDIMENTO - - FORNECIMENTO_EXTRATO_DE_UM_PERIODO_CONTA_DEPOSITOS_A_VISTA_E_POUPANCA_CORRESPONDENTES_PAIS - - FORNECIMENTO_COPIA_MICROFILME_MICROFICHA_ASSEMELHADO - - TRANSFERENCIA_DOC_PESSOAL_OU_PRESENCIAL - - TRANSFERENCIA_DOC_TERMINAL_AUTOATENDIMENTO_OUTROS_MEIOS_ELETRONICOS - - TRANSFERENCIA_DOC_INTERNET - - TRANSFERENCIA_TED_PESSOAL_OU_PRESENCIAL - - TRANSFERENCIA_TED_TERMINAL_AUTOATENDIMENTO_OUTROS_MEIOS_ELETRONICOS - - TRANSFERENCIA_TED_INTERNET - - TRANSFERENCIA_DOC_TED_PESSOAL_OU_PRESENCIAL - - TRANSFERENCIA_DOC_TED_TERMINAL_AUTOATENDIMENTO_OUTROS_MEIOS_ELETRONICOS - - TRANSFERENCIA_DOC_TED_INTERNET - - TRANSFERENCIA_ENTRE_CONTAS_PROPRIA_INSTITUICAO_PESSOAL_OU_PRESENCIAL - - TRANSFERENCIA_ENTRE_CONTAS_PROPRIA_INSTITUICAO_TERMINAL_AUTOATENDIMENTO_OUTROS_MEIOS_ELETRONICOS_INCLUSIVE_INTERNET - - ORDEM_PAGAMENTO - - ANUIDADE_CARTAO_BASICO_NACIONAL - - ANUIDADE_CARTAO_BASICO_INTERNACIONAL - - ANUIDADE_DIFERENCIADA - - UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_BRASIL - - UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_EXTERIOR - - AVALIACAO_EMERGENCIAL_CREDITO - - FORNECIMENTO_SEGUNDA_VIA_FUNCAO_CREDITO - - PAGAMENTO_CONTAS_UTILIZANDO_FUNCAO_CREDITO - - SMS - description: 'Nome dos Serviços prioritários, segundo Resolução 3.919 do Bacen, para pessoa natural.' - example: TRANSFERENCIA_TED_PESSOAL_OU_PRESENCIAL - AccountOtherService: - type: object - required: - - name - - code - - chargingTriggerInfo - - prices - - minimum - - maximum - properties: - name: - type: string - maxLength: 250 - pattern: '[\w\W\s]*' - description: 'Nome do Serviço que incide sobre tipo de conta (Campo Livre)' - example: Evento personalizado - code: - type: string - maxLength: 100 - pattern: '[\w\W\s]*' - description: 'Siglas de identificação do Serviço (Campo Livre)' - example: TALAO_DOMICILIO - chargingTriggerInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: Fatos geradores de cobrança que incidem sobre outros serviços para pessoa natural. (Campo Livre) - example: Cobrança devido a evento personalizado - prices: - type: array - items: - $ref: "#/components/schemas/PersonalAccountPrice" - minItems: 4 - maxItems: 4 - description: Lista distribuição preços tarifas de serviços - minimum: - $ref: "#/components/schemas/MinimumPrice" - maximum: - $ref: "#/components/schemas/MaximumPrice" - AccountPriorityServiceCode: - type: string - description: 'Lista das Siglas de identificação do Serviço Prioritário, segundo Resolução 3.919 do Bacen.' - enum: - - CADASTRO - - 2_VIA_CARTAO_DEBITO - - 2_VIA_CARTAO_POUPANCA - - EXCLUSAO_CCF - - SUSTACAO_REVOGACAO - - FOLHA_CHEQUE - - CHEQUE_ADMINISTRATIVO - - CHEQUE_VISADO - - SAQUE_PESSOAL - - SAQUE_TERMINAL - - SAQUE_CORRESPONDENTE - - DEPOSITO_IDENTIFICADO - - EXTRATO_MES_P - - EXTRATO_MES_E - - EXTRATO_MES_C - - EXTRATO_MOVIMENTO_P - - EXTRATO_MOVIMENTO_E - - EXTRATO_MOVIMENTO_C - - MICROFILME - - DOC_PESSOAL - - DOC_ELETRONICO - - DOC_INTERNET - - TED_PESSOAL - - TED_ELETRONICO - - TED_INTERNET - - DOC_TED_AGENDADO_P - - DOC_TED_AGENDADO_E - - DOC_TED_AGENDADO_I - - TRANSF_RECURSO_P - - TRANSF_RECURSO_E - - ORDEM_PAGAMENTO - - ANUIDADE_NACIONAL - - ANUIDADE_INTERNACIONAL - - ANUIDADE_DIFERENCIADA - - SAQUE_CARTAO_BRASIL - - SAQUE_CARTAO_EXTERIOR - - AVALIACAO_EMERGENCIAL_CREDITO - - EMISSAO_SEGUNDA_VIA - - TARIFA_PAGAMENTO_CONTAS - - SMS - ServiceBundle: - type: object - required: - - name - - services - - prices - - minimum - - maximum - properties: - name: - type: string - maxLength: 250 - pattern: '[\w\W\s]*' - description: Nome do Pacote de Serviços dado pela instituição. - example: Conta de depósitos à vista Movimentação com cartão (sem cheque) - services: - type: array - maxItems: 100 - items: - $ref: '#/components/schemas/ServiceBundleServiceDetail' - minItems: 1 - description: Lista dos serviços que compõe o pacote de serviços - prices: - type: array - items: - $ref: "#/components/schemas/MonthlyPrice" - minItems: 4 - maxItems: 4 - description: Lista distribuição preços tarifas de serviços - minimum: - $ref: "#/components/schemas/MinimumPrice" - maximum: - $ref: "#/components/schemas/MaximumPrice" - PersonalAccountServiceBundle: - type: object - required: - - name - - services - - prices - - minimum - - maximum - properties: - name: - type: string - maxLength: 250 - pattern: '[\w\W\s]*' - description: Nome do Pacote de Serviços dado pela instituição. - example: Conta de depósitos à vista Movimentação com cartão (sem cheque) - services: - type: array - items: - $ref: '#/components/schemas/ServiceBundleServiceDetail' - minItems: 1 - maxItems: 100 - description: Lista dos serviços que compõe o pacote de serviços - prices: - type: array - items: - $ref: "#/components/schemas/MonthlyPrice" - minItems: 4 - maxItems: 4 - description: Lista distribuição preços tarifas de serviços - minimum: - $ref: "#/components/schemas/MinimumPrice" - maximum: - $ref: "#/components/schemas/MaximumPrice" - ServiceBundleServiceDetail: - type: object - required: - - code - - chargingTriggerInfo - - eventLimitQuantity - - freeEventQuantity - properties: - code: - type: string - maxLength: 100 - pattern: '[\w\W\s]*' - description: | - Código que identifica o Serviço que compõe o Pacote de Serviços, podendo ser da lista de Serviços Prioritários ou Outros Serviços. p.ex. segundo Resolução 3.919 do Bacen: 'SAQUE_TERMINAL'. - example: SAQUE_TERMINAL - chargingTriggerInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: | - Fatos geradores de cobrança que incidem sobre serviço que compõe o Pacote de Serviços. - example: | - Realização de pesquisa em serviços de proteção ao crédito, base de dados e informações cadastrais, e tratamento de dados e informações necessários ao início relacionamento decorrente da abertura de conta de depósitos à vista ou de poupança ou contratação de operação de crédito ou de arrendamento mercantil, não podendo ser cobrada cumulativamente - eventLimitQuantity: - type: string - maxLength: 6 - pattern: ^(\d{1,6}){1}$ - description: | - Segundo Resolução 4196, BCB, de 2013: Quantidade de eventos previstos no Pacote de Serviços (Número de eventos incluídos no mês) p.ex.'2'. No caso de quantidade ilimitada, reportar 999999 - example: '2' - freeEventQuantity: - type: string - maxLength: 6 - pattern: ^(\d{1,6}){1}$ - description: | - Segundo Resolução 4196, BCB, de 2013: Quantidade de eventos previstos no Pacote de Serviços com isenção de Tarifa.p.ex.'1' No caso de quantidade ilimitada, reportar 999999 - example: '1' - AccountsIncomeRate: - type: object - properties: - savingAccount: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: | - Descrição da Remuneração especificamente para Conta de Poupança. Deve ser preenchido com a determinação legal vigente. - Restrição: De preenchimento obrigatório para CONTA_POUPANCA. - example: 'Para depósitos até 03/05/2012 – remuneração trimestral de 1,5% + TR, sempre creditada no aniversário da conta; Para depósitos a partir de 04/05/2012 – 70% da Selic + TR quando a Selic for igual ou inferior a 8,5% ao ano e 1,5% + TR caso a Selic seja superior a 8,5%.' - prepaidPaymentAccount: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: Campo Livre. Deve explicitar o Percentual em favor do titular da conta de pagamento pré-paga. - example: '40% Rendimento a.m.' - ResponseBusinessAccounts: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/BusinessAccountsBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - BusinessAccountsBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - maxLength: 80 - pattern: '[\w\W\s]*' - description: 'Nome da Instituição, pertencente à marca, responsável pela comercialização dos produtos e serviços' - example: Organização A - companies: - type: array - maxItems: 700 - items: - $ref: '#/components/schemas/BusinessAccountsCompany' - minItems: 1 - description: Companies traz uma lista de todas as instituições da Marca - BusinessAccountsCompany: - type: object - required: - - name - - cnpjNumber - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - businessAccounts: - type: array - items: - $ref: "#/components/schemas/BusinessAccounts" - minItems: 1 - maxItems: 3 - description: lista de tipos de conta - BusinessAccounts: - type: object - required: - - type - - fees - - openingClosingChannels - - transactionMethods - - termsConditions - - incomeRate - properties: - type: - $ref: "#/components/schemas/AccountType" - fees: - type: object - description: Objeto que reúne informações de tarifas de serviços - required: - - services - properties: - services: - type: array - maxItems: 200 - items: - $ref: '#/components/schemas/BusinessAccountsService' - minItems: 1 - description: Lista das Tarifas cobradas sobre Serviços - serviceBundles: - type: array - maxItems: 100 - items: - $ref: "#/components/schemas/ServiceBundle" - minItems: 1 - description: | - Lista dos serviços que compõe o pacote de serviços - - [Restrição] - - Caso o ENUM do campo “type” seja CONTA_PAGAMENTO_PRE_PAGA a estrutura “serviceBundle” fica condicionado caso a instituição tenha pacote de serviço - atrelado a este tipo de conta, porque são contas com serviços essenciais padronizados e regulados pela Resolução BACEN 3919, de 25/11/2010 - - - Caso o ENUM do campo “type” seja CONTA_DEPOSITO_A_VISTA (conta corrente) ou CONTA_POUPANCA, deverá ser incluso a estrutura “serviceBundle”, porque - existem hoje pacotes passíveis de cobrança diferentes dos serviços essenciais (que não são cobrados) - openingClosingChannels: - type: array - items: - $ref: '#/components/schemas/OpeningClosingChannels' - minItems: 1 - maxItems: 7 - description: Lista dos canais para aberturas e encerramento - additionalInfo: - type: string - maxLength: 100 - pattern: '[\w\W\s]*' - description: | - Texto livre para complementar informação relativa ao Canal disponível, quando no campo ''openingClosingChannels'' estiver preenchida a opção ''Outros'' - Restrição: Campo de preenchimento obrigatório se ''openingCloseChannels'' estiver preenchida a opção ''OUTROS'' - example: 'NA' - transactionMethods: - type: array - items: - $ref: '#/components/schemas/TransactionMethods' - minItems: 1 - maxItems: 4 - description: Lista de formas de movimentação - termsConditions: - $ref: '#/components/schemas/AccountsTermsConditions' - incomeRate: - $ref: '#/components/schemas/AccountsIncomeRate' - BusinessAccountsService: - type: object - required: - - name - - code - - chargingTriggerInfo - - prices - - minimum - - maximum - properties: - name: - type: string - maxLength: 250 - pattern: '[\w\W\s]*' - description: 'Nome do Serviço que incide sobre tipo de conta selecionado para pessoa jurídica(Campo Livre)' - example: Evento personalizado - code: - type: string - maxLength: 100 - pattern: '[\w\W\s]*' - description: Sigla de identificação de Outros Serviços que incidem sobre os tipos de contas informados. - example: EVENTO_PERSONALIZADO - chargingTriggerInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: Fatos geradores de cobrança que incidem sobre serviço que compõe o Pacote de Serviços. - example: Cobrança devido a evento personalizado - prices: - type: array - items: - $ref: '#/components/schemas/Price' - minItems: 4 - maxItems: 4 - description: Lista distribuição preços tarifas de serviços - minimum: - $ref: '#/components/schemas/MinimumPrice' - maximum: - $ref: '#/components/schemas/MaximumPrice' - ResponsePersonalLoans: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/PersonalLoanBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - PersonalLoanBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 80 - description: Nome da Marca. - example: Organização A - companies: - type: array - items: - $ref: '#/components/schemas/PersonalLoanCompany' - minItems: 1 - description: Companies traz uma lista de todas as instituições da Marca - PersonalLoanCompany: - type: object - required: - - name - - cnpjNumber - - personalLoans - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 80 - description: 'Nome da Instituição, pertencente à marca, responsável pela comercialização dos produtos e serviços' - example: Empresa da Marca A - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. - example: 'https://example.com/mobile-banking' - personalLoans: - type: array - items: - $ref: '#/components/schemas/PersonalLoan' - minItems: 1 - maxItems: 6 - description: Lista de modalidades de empréstimos - ResponseBusinessLoans: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/BusinessLoanBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - BusinessLoanBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 80 - description: Nome da Marca reportada pelo participante do Open Finance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes - example: Organização A - companies: - type: array - items: - $ref: '#/components/schemas/BusinessLoanCompany' - minItems: 1 - description: Companies traz uma lista de todas as instituições da Marca - BusinessLoanCompany: - type: object - required: - - name - - cnpjNumber - - businessLoans - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 80 - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - example: Empresa A1 - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. - example: 'https://example.com/mobile-banking' - businessLoans: - type: array - items: - $ref: '#/components/schemas/BusinessLoan' - minItems: 1 - maxItems: 6 - description: Lista de modalidades de empréstimos - PersonalLoan: - type: object - required: - - type - - fees - - interestRate - - requiredWarranties - - termsConditions - properties: - type: - type: string - enum: - - EMPRESTIMO_CREDITO_PESSOAL_CONSIGNADO - - EMPRESTIMO_CREDITO_PESSOAL_SEM_CONSIGNACAO - - EMPRESTIMO_HOME_EQUITY - - EMPRESTIMO_MICROCREDITO_PRODUTIVO_ORIENTADO - - EMPRESTIMO_CHEQUE_ESPECIAL - - EMPRESTIMO_CONTA_GARANTIDA - description: | - Modalidades de empréstimos ofertados para pessoa Natural, conforme Circular 4015-Bacen. Segundo cartilha do Bacen: Empréstimo é um contrato entre o cliente e uma instituição financeira (banco, cooperativa de crédito, caixa econômica) pelo qual o cliente recebe uma quantia em dinheiro que deverá ser devolvida em prazo determinado, acrescida dos juros acertados. Os recursos obtidos no empréstimo não tem destinação específica. - * `EMPRESTIMO_CREDITO_PESSOAL_CONSIGNADO` - operações de crédito com retenção de parcela do salário ou benefício do tomador, para o pagamento das prestações do empréstimo – desconto em folha de pagamento – nos termos da legislação em vigor - * `EMPRESTIMO_CREDITO_PESSOAL_SEM_CONSIGNACAO` - operações de empréstimos às pessoa natural, sem vinculação com aquisição de bem ou serviço e sem retenção de parcela do salário ou benefício do tomador para o pagamento das prestações do empréstimo - * `EMPRESTIMO_HOME_EQUITY` - empréstimos pessoa natural, garantidos por hipoteca ou por alienação fiduciária de bens imóveis residenciais, sem vinculação a aquisição de bens - * `EMPRESTIMO_MICROCREDITO_PRODUTIVO_ORIENTADO` - segundo PNMPO é o crédito concedido para financiamento das atividades produtivas, cuja metodologia será estabelecida em regulamento, observada a preferência do relacionamento direto com os empreendedores, admitido o uso de tecnologias digitais e eletrônicas que possam substituir o contato presencial - * `EMPRESTIMO_CHEQUE_ESPECIAL` - operações de crédito vinculadas à conta corrente, nas quais determinado limite de crédito é disponibilizado aos clientes para utilização de acordo com suas conveniências, sem necessidade de comunicação prévia à instituição financeira - * `EMPRESTIMO_CONTA_GARANTIDA` - operações de crédito rotativo, nas quais determinado limite de crédito é disponibilizado para utilização pelo cliente, através da simples movimentação da conta corrente e/ou solicitação formal à instituição financeira. As operações classificadas nessa modalidade não devem ter data definida para a amortização do saldo devedor, exceto a estabelecida para vigência do contrato - example: EMPRESTIMO_CREDITO_PESSOAL_CONSIGNADO - fees: - $ref: '#/components/schemas/LoanFees' - interestRates: - type: array - items: - $ref: '#/components/schemas/LoanInterestRate' - minItems: 1 - description: Lista que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios da Modalidade de crédito - requiredWarranties: - type: array - items: - $ref: '#/components/schemas/RequiredWarranty' - minItems: 1 - maxItems: 14 - description: Lista das garantias exigidas - termsConditions: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Campo aberto para informar as condições contratuais relativas à Modalidade de Financiamentos para pessoa jurídica informada. Pode ser informada a URL referente ao endereço onde constam as condições informadas. Endereço eletrônico de acesso ao canal. - example: 'https://empresaa1.com/personal_loans' - BusinessLoan: - type: object - required: - - type - - fees - - interestRate - - requiredWarranties - - termsConditions - properties: - type: - type: string - enum: - - EMPRESTIMO_MICROCREDITO_PRODUTIVO_ORIENTADO - - EMPRESTIMO_CHEQUE_ESPECIAL - - EMPRESTIMO_CONTA_GARANTIDA - - EMPRESTIMO_CAPITAL_GIRO_PRAZO_VENCIMENTO_ATE_365_DIAS - - EMPRESTIMO_CAPITAL_GIRO_PRAZO_VENCIMENTO_SUPERIOR_365_DIAS - - EMPRESTIMO_CAPITAL_GIRO_ROTATIVO - description: | - Modalidades de empréstimos ofertados para pessoas Jurídicas, conforme Circular 4015-Bacen. Segundo cartilha do Bacen: Empréstimo é um contrato entre o cliente e uma instituição financeira (banco, cooperativa de crédito, caixa econômica) pelo qual o cliente recebe uma quantia em dinheiro que deverá ser devolvida em prazo determinado, acrescida dos juros acertados. Os recursos obtidos no empréstimo não tem destinação específica. - * Empréstimo-Microcrédito Produtivo Orientado - segundo PNMPO é o crédito concedido para financiamento das atividades produtivas, cuja metodologia será estabelecida em regulamento, observada a preferência do relacionamento direto com os empreendedores, admitido o uso de tecnologias digitais e eletrônicas que possam substituir o contato presencial - * Empréstimo-Cheque especial - operações de crédito vinculadas à conta corrente, nas quais determinado limite de crédito é disponibilizado aos clientes para utilização de acordo com suas conveniências, sem necessidade de comunicação prévia à instituição financeira - * Empréstimo-Conta garantida - operações de crédito rotativo, nas quais determinado limite de crédito é disponibilizado para utilização pelo cliente, através da simples movimentação da conta corrente e/ou solicitação formal à instituição financeira. As operações classificadas nessa modalidade não devem ter data definida para a amortização do saldo devedor, exceto a estabelecida para vigência do contrato - * Empréstimo-Capital de giro com prazo de vencimento até 365 dias: operações de crédito voltadas para o financiamento de curto prazo (igual ou inferior a 365 dias) das pessoas jurídicas, vinculadas às necessidades de capital de giro e a um contrato específico que estabeleça prazos, taxas e garantias - * Empréstimo-Capital de giro com prazo vencimento superior a 365 dias: operações de crédito voltadas para o financiamento de médio e longo prazo (superior a 365 dias) das pessoas jurídicas, vinculadas às necessidades de capital de giro e a um contrato específico que estabeleça prazos, taxas e garantias - * Empréstimo-Capital de giro rotativo: operações de crédito voltadas para o financiamento de capital de giro, vinculadas a um contrato que estabeleça linha de crédito rotativo, de forma que, à medida que a empresa devedora amortize os empréstimos já tomados, o limite disponível para utilização seja restituído, e amortizações com datas predeterminadas, podendo ser facultado ao devedor repactuar o fluxo de pagamentos ao longo da vigência do contrato - example: EMPRESTIMO_MICROCREDITO_PRODUTIVO_ORIENTADO - fees: - $ref: '#/components/schemas/LoanFees' - interestRates: - type: array - items: - $ref: '#/components/schemas/LoanInterestRate' - minItems: 1 - description: Lista que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios da Modalidade de crédito - requiredWarranties: - type: array - items: - $ref: '#/components/schemas/RequiredWarranty' - minItems: 1 - maxItems: 14 - description: Lista das garantias exigidas - termsConditions: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Campo aberto para informar as condições contratuais relativas à Modalidade de Empréstimo para pessoa jurídica informada. Pode ser informada a URL referente ao endereço onde constam as condições informadas. Endereço eletrônico de acesso ao canal. - example: 'https://empresaa1.com/personal_loans' - LoanFees: - type: object - properties: - services: - type: array - items: - $ref: '#/components/schemas/LoanService' - minItems: 1 - description: Lista das Tarifas cobradas sobre Serviços - description: Objeto que reúne informações de tarifas de serviços - LoanService: - type: object - required: - - name - - code - - chargingTriggerInfo - - prices - - minimum - - maximum - - customers - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 250 - description: Nomes das Tarifas cobradas sobre Serviços relacionados à Modalidade informada do Empréstimo para pessoa natural/jurídica. - example: Taxa de Abertura - code: - type: string - pattern: '[\w\W\s]*' - maxLength: 100 - description: Sigla de identificação do serviço relacionado à Modalidade informada de Empréstimo para pessoa natural/jurídica. - example: NA - chargingTriggerInfo: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Fatores geradores de cobrança que incidem sobre as Modalidades informada de Empréstimos para pessoa natural/jurídica. - example: 3% do valor do contrato - prices: - type: array - items: - $ref: '#/components/schemas/Price' - minItems: 4 - maxItems: 4 - minimum: - $ref: '#/components/schemas/MinimumPrice' - maximum: - $ref: '#/components/schemas/MaximumPrice' - LoanInterestRate: - required: - - referentialRateIndexer - - rate - - applications - - minimumRate - - maximumRate - type: object - properties: - referentialRateIndexer: - type: string - enum: - - SEM_INDEXADOR_TAXA - - PRE_FIXADO - - POS_FIXADO_TR_TBF - - POS_FIXADO_TJLP - - POS_FIXADO_LIBOR - - POS_FIXADO_TLP - - OUTRAS_TAXAS_POS_FIXADAS - - FLUTUANTES_CDI - - FLUTUANTES_SELIC - - OUTRAS_TAXAS_FLUTUANTES - - INDICES_PRECOS_IGPM - - INDICES_PRECOS_IPCA - - INDICES_PRECOS_IPCC - - OUTROS_INDICES_PRECO - - CREDITO_RURAL_TCR_PRE - - CREDITO_RURAL_TCR_POS - - CREDITO_RURAL_TRFC_PRE - - CREDITO_RURAL_TRFC_POS - - OUTROS_INDEXADORES - description: 'Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040' - example: PRE_FIXADO - rate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: | - Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%) A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.150000' - minLength: 8 - maxLength: 8 - applications: - type: array - items: - $ref: '#/components/schemas/ApplicationRate' - minItems: 4 - maxItems: 4 - description: Lista das faixas de cobrança da taxa efetiva aplicada pela contratação de crédito - minimumRate: - type: string - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - description: 'Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Empréstimo contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - example: '0.045600' - maximumRate: - type: string - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - description: 'Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Empréstimo contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - example: '0.686500' - ApplicationRate: - type: object - properties: - interval: - $ref: '#/components/schemas/ApplicationIntervals' - indexer: - $ref: '#/components/schemas/Indexer' - customers: - $ref: '#/components/schemas/Customer' - required: - - interval - - indexer - - customers - Indexer: - type: object - properties: - rate: - type: string - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - description: | - Percentual que corresponde a mediana da taxa efetiva cobrada do cliente pela contratação do crédito, no intervalo informado. p.ex. '0,8700%'. A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.870000' - PriceIntervals: - type: string - enum: - - 1_FAIXA - - 2_FAIXA - - 3_FAIXA - - 4_FAIXA - description: | - Segundo Normativa nº 32, BCB, de 2020: Distribuição de frequência relativa dos valores de tarifas cobradas dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana em cada uma dessas faixas. Informando: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa - example: 1_FAIXA - PersonalAccountPriceIntervals: - type: string - enum: - - 1_FAIXA - - 2_FAIXA - - 3_FAIXA - - 4_FAIXA - description: | - Segundo Normativa nº 32, BCB, de 2020: Distribuição de frequência relativa dos valores de tarifas cobradas dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana em cada uma dessas faixas. Informando: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa - example: 1_FAIXA - ApplicationIntervals: - type: string - enum: - - 1_FAIXA - - 2_FAIXA - - 3_FAIXA - - 4_FAIXA - description: | - Faixas para cobrança da taxa efetiva aplicada pela contratação do crédito, no intervalo informado: 1ª faixa, 2ª faixa, 3ª faixa e 4ª faixa. Segundo Normativa nº32 de 2020: 'Distribuição de frequência relativa dos valores de tarifas e taxas de juros cobrados dos clientes, de que trata o § 2º do art. 3º da Circular nº 4.015, de 2020, deve dar-se com base em quatro faixas de igual tamanho, com explicitação dos valores sobre a mediana e o percentual de clientes em cada uma dessas faixas. - RequiredWarranty: - type: string - enum: - - CESSAO_DIREITOS_CREDITORIOS - - CAUCAO - - PENHOR - - ALIENACAO_FIDUCIARIA - - HIPOTECA - - OPERACOES_GARANTIDAS_PELO_GOVERNO - - OUTRAS_GARANTIAS_NAO_FIDEJUSSORIAS - - SEGUROS_ASSEMELHADOS - - GARANTIA_FIDEJUSSORIA - - BENS_ARRENDADOS - - GARANTIAS_INTERNACIONAIS - - OPERACOES_GARANTIDAS_OUTRAS_ENTIDADES - - ACORDOS_COMPENSACAO - - NAO_APLICAVEL - description: | - Relação de garantias exigidas, segundo documento 3040 do Bacen: - * `cessão de direitos creditórios`: o cedente transfere ao credor/cessionário a titularidade de direitos creditórios, até a liquidação da dívida. O credor/cessionário passa a recebê-los diretamente dos devedores e credita o produto da operação para o cedente na operação que originou a cessão, até a sua liquidação - * `caução`: garantia instituída sobre créditos do garantidor - * `penhor`: direito real que consiste na tradição de uma coisa móvel ou mobilizável, suscetível de alienação, realizada pelo devedor ou por terceiro ao credor, a fim de garantir o pagamento do débito - * `alienação fiduciária`: transferência ao credor, ou fiduciário, da propriedade do bem - * `hipoteca`: direito real de garantia que afeta um bem imóvel para o cumprimento da obrigação - * `operações garantidas pelo governo`: nas instâncias federal, estadual ou municipal - * `outras garantias não fidejussórias`: as garantias reais não descritas como: cessão de direitos creditórios, caução, penhor, alienação fiduciária, hipoteca ou operação garantida pelo governo - * `seguros e assemelhados`: os seguros (e assemelhados) contratados para garantir o pagamento da operação em circunstâncias adversas - * `garantia fidejussória`: baseada na fidelidade do garantidor em cumprir as obrigações, caso o devedor não o faça - * `bens arrendados`: bem objeto do arrendamento financeiro - * `garantias internacionais`: declarar se a garantia é mitigadora ou não, observados os critérios definidos pela Circular 3.644, de 4 de março de 2013 - * `operações garantidas por outras entidade`: declarar as garantias prestadas pelas entidades descritas no item 3. Informações de Garantias (i) do documento 3040 - Bacen - * `acordos de compensação`: operações que sejam abrangidas por acordos para a compensação e liquidação de obrigações no âmbito do SFN, nos termos da Resolução 3.263, de 24 de fevereiro de 2005 - * `não aplicável` - example: CESSAO_DIREITOS_CREDITORIOS - CreditCardIdentification: - type: object - required: - - product - - creditCard - properties: - product: - type: object - required: - - type - - additionalInfo - properties: - type: - type: string - enum: - - CLASSIC_NACIONAL - - CLASSIC_INTERNACIONAL - - GOLD - - PLATINUM - - INFINITE - - ELECTRON - - STANDARD_NACIONAL - - STANDARD_INTERNACIONAL - - ELETRONIC - - BLACK - - REDESHOP - - MAESTRO_MASTERCARD_MAESTRO - - GREEN - - BLUE - - BLUEBOX - - PROFISSIONAL_LIBERAL - - CHEQUE_ELETRONICO - - CORPORATIVO - - EMPRESARIAL - - COMPRAS - - OUTROS - description: 'Categoria atribuída a um cartão de pagamento, sob uma certa denominação, que lhe agrega um conjunto de vantagens, diferenciando-o de acordo com o perfil do portador. Essa categoria é definida pelo BACEN e está contida no documento de nome ''Elaboração e Remessa de Informações Relativas aos Cartões de Pagamento Emissores''' - example: PLATINUM - additionalInfo: - type: string - maxLength: 50 - pattern: '[\w\W\s]*' - description: 'Informações complementares se tipo de Cartão ''OUTROS''. Campo deve ser obrigatoriamente preenchido se selecionado ''OUTROS''' - example: 'NA' - creditCard: - type: object - required: - - network - - additionalInfo - properties: - network: - type: string - enum: - - VISA - - MASTERCARD - - AMERICAN_EXPRESS - - DINERS_CLUB - - HIPERCARD - - BANDEIRA_PROPRIA - - CHEQUE_ELETRONICO - - ELO - - OUTRAS - description: 'Categoria de Bandeiras de Cartões de Crédito (Instituidor do arranjo de pagamento). Bandeira é a detentora de todos os direitos e deveres da utilização da marca estampada no cartão, inclusive as bandeiras pertencentes aos emissores. p.ex. "American Express", "Diners Club" Essas bandeiras estão definidas em documento do BACEN de nome "Elaboração e Remessa de Informações Relativas aos Cartões de Pagamento Emissores"' - example: MASTERCARD - additionalInfo: - type: string - maxLength: 50 - pattern: '[\w\W\s]*' - description: "Texto livre para especificar categoria de bandeira marcada como 'OUTRAS'. Campo deve ser obrigatoriamente preenchido se campo network vier selecionado como 'OUTROS'" - example: 'NA' - CreditCardRewardsProgram: - type: object - required: - - hasRewardProgram - properties: - hasRewardProgram: - type: boolean - description: 'Indicador da existência de programa de fidelidade/recompensa associado à conta de pagamento pós-paga (cartão) true false' - example: false - rewardProgramInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: Informações de termos e condições do programa de fidelidade/recompensa. Pode ser informada a URL referente ao endereço onde constam as condições informadas. Será de preenchimento obrigatório caso o campo hasRewardProgram esteja preenchido como true - example: 'https://empresaa1.com/credit_cards_rewards' - CreditCardTermsConditions: - type: object - required: - - minimumFeeRate - - elegibilityCriteriaInfo - - closingProcessInfo - properties: - minimumFeeRate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: Percentual para pagamento mínimo sobre o saldo devedor da fatura. - example: '0.250000' - minLength: 8 - maxLength: 8 - additionalInfo: - type: string - maxLength: 500 - pattern: '[\w\W\s]*' - description: Campo aberto para detalhamento de taxas de juros - example: 'NA' - elegibilityCriteriaInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: 'Informação sobre as condições e critérios de elegibilidade do emissor do cartão. Pode ser informada a URL referente ao endereço onde constam as condições informadas.' - example: 'https://empresaa1.com/creditcards_elegibility_criteria' - closingProcessInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: 'Descrição dos procedimentos para encerramento da conta de pagamento pós paga. Pode ser informada a URL referente ao endereço onde constam as condições informadas.' - example: 'https://empresaa1.com/creditcards_closing_process' - CreditCardInterest: - type: object - description: Informações sobre taxas de juros - required: - - rates - - instalmentRates - - otherCredits - properties: - rates: - type: array - items: - $ref: '#/components/schemas/InterestRate' - minItems: 1 - maxItems: 20 - description: Lista da representação que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios para crédito rotativo - instalmentRates: - type: array - items: - $ref: '#/components/schemas/InterestRate' - minItems: 1 - maxItems: 20 - description: Lista da representação que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios para parcelamento do saldo devedor - otherCredits: - type: array - description: Lista de outras operações de crédito - items: - $ref: "#/components/schemas/CreditCardInterestRate" - minItems: 1 - maxItems: 3 - CreditCardInterestRate: - type: object - required: - - code - - additionalInfo - properties: - code: - type: string - enum: - - SAQUE_A_CREDITO - - PAGAMENTOS_CONTAS - - OUTROS - description: Lista de outras operações de crédito - example: SAQUE_A_CREDITO - additionalInfo: - type: string - maxLength: 50 - pattern: '[\w\W\s]*' - description: Campo Texto para descrever outras operações de crédito marcadas como 'OUTROS'. Se o campo 'code' vier selecionado com 'OUTROS' é obrigatório o preenchimento do additionalInfo - example: NA - PersonalCreditCardResponse: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/PersonalCreditCardBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - PersonalCreditCardBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - maxLength: 80 - pattern: '[\w\W\s]*' - description: Nome da Marca selecionada pelas Organizações - example: Organização A - companies: - type: array - description: Companies traz uma lista de todas as instituições da Marca - items: - $ref: '#/components/schemas/PersonalCreditCardCompany' - minItems: 1 - maxItems: 800 - PersonalCreditCardCompany: - type: object - required: - - name - - cnpjNumber - - personalCreditCards - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - personalCreditCards: - type: array - description: Lista das contas de pagamento pós-paga - items: - $ref: '#/components/schemas/PersonalCreditCard' - minItems: 1 - maxItems: 300 - BusinessCreditCardResponse: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/BusinessCreditCardBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - BusinessCreditCardBrand: - type: object - required: - - companies - properties: - name: - type: string - maxLength: 80 - pattern: '[\w\W\s]*' - description: Nome da Marca selecionada pelas Organizações - example: Organização A - companies: - type: array - description: Companies traz uma lista de todas as instituições da Marca - items: - $ref: '#/components/schemas/BusinessCreditCardCompany' - minItems: 1 - maxItems: 720 - BusinessCreditCardCompany: - type: object - required: - - name - - cnpjNumber - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - businessCreditCards: - type: array - description: Lista dos nomes de conta de pagamento pós-paga - items: - $ref: '#/components/schemas/BusinessCreditCard' - minItems: 1 - maxItems: 80 - CreditCardService: - type: object - required: - - name - - code - - chargingTriggerInfo - - prices - - minimum - - maximum - properties: - name: - type: string - enum: - - ANUIDADE_CARTAO_BASICO_NACIONAL - - ANUIDADE_CARTAO_BASICO_INTERNACIONAL - - ANUIDADE_DIFERENCIADA - - UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_BRASIL - - UTILIZACAO_CANAIS_ATENDIMENTO_RETIRADA_ESPECIE_EXTERIOR - - AVALIACAO_EMERGENCIAL_CREDITO - - FORNECIMENTO_SEGUNDA_VIA_FUNCAO_CREDITO - - PAGAMENTO_CONTAS_UTILIZANDO_FUNCAO_CREDITO - - SMS - description: 'Denominação de Serviços relacionados à Modalidade de Contas de Pagamento Pós-Pagas (Vide ENUM)' - example: ANUIDADE_CARTAO_BASICO_NACIONAL - code: - type: string - enum: - - ANUIDADE_NACIONAL - - ANUIDADE_INTERNACIONAL - - ANUIDADE_DIFERENCIADA - - SAQUE_CARTAO_BRASIL - - SAQUE_CARTAO_EXTERIOR - - AVALIACAO_EMERGENCIAL_CREDITO - - EMISSAO_SEGUNDA_VIA - - TARIFA_PAGAMENTO_CONTAS - - SMS - description: 'Sigla de identificação do Serviço relacionado à Modalidade de Contas de Pagamento Pós-Pagas (Vide ENUM)' - example: ANUIDADE_NACIONAL - chargingTriggerInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: 'Fatos geradores de cobrança que incidem sobre as Modalidades de Contas de Pagamento Pós-Pagas informada, para pessoa jurídica. (Campo Livre)' - example: 'Disponibilização de rede de estabelecimentos afiliados, instalada no País, para pagamentos de bens e serviços, cobrada no máximo uma vez a cada doze meses, admitido o parcelamento da cobrança' - prices: - type: array - description: Lista distribuição preços tarifas de serviços - items: - $ref: '#/components/schemas/Price' - minItems: 4 - maxItems: 4 - minimum: - $ref: '#/components/schemas/MinimumPrice' - maximum: - $ref: '#/components/schemas/MaximumPrice' - ResponsePersonalFinancings: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/PersonalFinancingBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - PersonalFinancingBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - maxLength: 80 - pattern: '[\w\W\s]*' - description: Nome da Marca selecionada pelas Organizações - example: Organização A - companies: - type: array - items: - $ref: '#/components/schemas/PersonalFinancingCompany' - minItems: 1 - description: Lista de instituições pertencentes à marca - PersonalFinancingCompany: - type: object - required: - - name - - cnpjNumber - - personalFinancings - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - personalFinancings: - type: array - items: - $ref: '#/components/schemas/PersonalFinancing' - minItems: 1 - maxItems: 9 - description: Lista de financiamentos - PersonalFinancing: - type: object - required: - - type - - fees - - interestRates - - requiredWarranties - - termsConditions - properties: - type: - type: string - enum: - - FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES - - FINANCIAMENTO_AQUISICAO_BENS_OUTROS_BENS - - FINANCIAMENTO_MICROCREDITO - - FINANCIAMENTO_RURAL_CUSTEIO - - FINANCIAMENTO_RURAL_INVESTIMENTO - - FINANCIAMENTO_RURAL_COMERCIALIZACAO - - FINANCIAMENTO_RURAL_INDUSTRIALIZACAO - - FINANCIAMENTO_IMOBILIARIO_SISTEMA_FINANCEIRO_HABITACAO_SFH - - FINANCIAMENTO_IMOBILIARIO_SISTEMA_FINANCEIRO_HABITACAO_SFI - description: 'Modalidades de financiamentos ofertados para pessoas naturais, conforme Circular 4015-Bacen. Segundo cartilha do Bacen: Financiamento é um contrato entre o cliente e uma instituição financeira, mas com, destinação específica como para a aquisição de veículo ou de bem imóvel, que funcionam como garantia para o crédito concedido' - example: FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES - fees: - $ref: '#/components/schemas/PersonalFinancingFee' - interestRates: - type: array - items: - $ref: '#/components/schemas/FinancingInterestRate' - minItems: 1 - description: Lista que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios da Modalidade de crédito - requiredWarranties: - type: array - items: - $ref: '#/components/schemas/RequiredWarranty' - minItems: 1 - maxItems: 14 - termsConditions: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Campo aberto para informar as condições contratuais relativas ao produto ou serviço informado. Pode ser informada a URL referente ao endereço onde constam as condições informadas. - example: 'https://empresaa1.com/personal_financing' - PersonalFinancingFee: - type: object - required: - - services - properties: - services: - type: array - items: - $ref: '#/components/schemas/FinancingService' - minItems: 1 - FinancingService: - type: object - properties: - name: - type: string - pattern: '[\w\W\s]*' - description: 'Nomes das Tarifas cobradas sobre Serviços ofertados à Modalidade de Financiamento, para pessoa natural' - maxLength: 250 - example: 'Avaliação, Reavaliação e Substituição de Bens Recebidos em Garantia' - code: - type: string - pattern: '[\w\W\s]*' - description: 'Sigla de identificação do serviço relacionado à Modalidade de Financiamento informada, para pessoa natural. Campo aberto' - maxLength: 100 - example: AQBAM009 - chargingTriggerInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: 'Fatores geradores de cobrança que incidem sobre as Modalidades de Financiamentos, para pessoa natural. Campo Livre' - example: 'R$ 570.00 Por solicitação' - prices: - type: array - items: - $ref: '#/components/schemas/Price' - minItems: 4 - maxItems: 4 - minimum: - $ref: '#/components/schemas/MinimumPrice' - maximum: - $ref: '#/components/schemas/MaximumPrice' - required: - - name - - code - - prices - - minimum - - maximum - - chargingTriggerInfo - FinancingInterestRate: - type: object - required: - - referentialRateIndexer - - rate - - applications - - minimumRate - - maximumRate - properties: - referentialRateIndexer: - type: string - enum: - - SEM_INDEXADOR_TAXA - - PRE_FIXADO - - POS_FIXADO_TR_TBF - - POS_FIXADO_TJLP - - POS_FIXADO_LIBOR - - POS_FIXADO_TLP - - OUTRAS_TAXAS_POS_FIXADAS - - FLUTUANTES_CDI - - FLUTUANTES_SELIC - - OUTRAS_TAXAS_FLUTUANTES - - INDICES_PRECOS_IGPM - - INDICES_PRECOS_IPCA - - INDICES_PRECOS_IPCC - - OUTROS_INDICES_PRECO - - CREDITO_RURAL_TCR_PRE - - CREDITO_RURAL_TCR_POS - - CREDITO_RURAL_TRFC_PRE - - CREDITO_RURAL_TRFC_POS - - OUTROS_INDEXADORES - description: 'Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040' - example: PRE_FIXADO - rate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: | - Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%) A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.150000' - minLength: 8 - maxLength: 8 - applications: - type: array - items: - $ref: '#/components/schemas/ApplicationRate' - minItems: 4 - maxItems: 4 - example: - - interval: 1_FAIXA - indexer: - rate: '0.098700' - customers: - rate: '0.150000' - - interval: 2_FAIXA - indexer: - rate: '0.160000' - customers: - rate: '0.350000' - - interval: 3_FAIXA - indexer: - rate: '0.360000' - customers: - rate: '0.200000' - - interval: 4_FAIXA - indexer: - rate: '0.589000' - customers: - rate: '0.300000' - minimumRate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: 'Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - example: '0.045600' - minLength: 8 - maxLength: 8 - maximumRate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: 'Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - example: '0.686500' - minLength: 8 - maxLength: 8 - ResponseBusinessFinancings: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/BusinessFinancingBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - BusinessFinancingBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - maxLength: 80 - pattern: '[\w\W\s]*' - description: Nome da Marca selecionada pelas Organizações - example: Organização A - companies: - type: array - items: - $ref: '#/components/schemas/BusinessFinancingCompany' - minItems: 1 - description: Lista de instituições pertencentes à marga - BusinessFinancingCompany: - type: object - required: - - name - - cnpjNumber - - businessFinancings - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - businessFinancings: - type: array - items: - $ref: '#/components/schemas/BusinessFinancing' - minItems: 1 - maxItems: 9 - description: Lista de financiamentos - BusinessFinancing: - type: object - required: - - type - - fees - - interestRates - - requiredWarranties - - termsConditions - properties: - type: - type: string - enum: - - FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES - - FINANCIAMENTO_AQUISICAO_BENS_OUTROS_BENS - - FINANCIAMENTO_MICROCREDITO - - FINANCIAMENTO_RURAL_CUSTEIO - - FINANCIAMENTO_RURAL_INVESTIMENTO - - FINANCIAMENTO_RURAL_COMERCIALIZACAO - - FINANCIAMENTO_RURAL_INDUSTRIALIZACAO - - FINANCIAMENTO_IMOBILIARIO_SISTEMA_FINANCEIRO_HABITACAO_SFH - - FINANCIAMENTO_IMOBILIARIO_SISTEMA_FINANCEIRO_HABITACAO_SFI - description: 'Modalidades de financiamentos ofertados para pessoas jurídicas, conforme Circular 4015-Bacen. Segundo cartilha do Bacen: Financiamento é um contrato entre o cliente e uma instituição financeira, mas com, destinação específica como para a aquisição de veículo ou de bem imóvel, que funcionam como garantia para o crédito concedido' - example: FINANCIAMENTO_AQUISICAO_BENS_VEICULOS_AUTOMOTORES - fees: - $ref: '#/components/schemas/BusinessFinancingFee' - interestRates: - type: array - items: - $ref: '#/components/schemas/FinancingInterestRate' - minItems: 1 - description: Lista que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios da Modalidade de crédito - requiredWarranties: - type: array - items: - $ref: '#/components/schemas/RequiredWarranty' - minItems: 1 - maxItems: 14 - termsConditions: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Campo aberto para informar as condições contratuais relativas à Modalidade de Financiamentos para pessoa jurídica informada. Pode ser informada a URL referente ao endereço onde constam as condições informadas. Endereço eletrônico de acesso ao canal. - example: 'https://empresaa1.com/personal_financing' - BusinessFinancingFee: - type: object - description: Objeto que reúne informações de tarifas de serviços - properties: - services: - type: array - items: - $ref: '#/components/schemas/FinancingService' - minItems: 1 - required: - - services - ResponsePersonalInvoiceFinancings: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/PersonalInvoiceFinancingsBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - PersonalInvoiceFinancingsBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 80 - description: Nome da marca. - example: Organização A - companies: - type: array - items: - $ref: '#/components/schemas/PersonalInvoiceFinancingsCompanies' - minItems: 1 - description: Companies traz uma lista de todas as instituições da Marca - PersonalInvoiceFinancingsCompanies: - type: object - required: - - name - - cnpjNumber - - personalInvoiceFinancings - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - personalInvoiceFinancings: - type: array - items: - $ref: '#/components/schemas/PersonalInvoiceFinancings' - minItems: 1 - maxItems: 5 - description: Lista de Modalidades de Direitos Creditórios Descontados ofertados - PersonalInvoiceFinancings: - type: object - required: - - type - - fees - - interestRates - - requiredWarranties - - termsConditions - properties: - type: - type: string - enum: - - DESCONTO_DUPLICATAS - - DESCONTO_CHEQUES - - ANTECIPACAO_FATURA_CARTAO_CREDITO - - OUTROS_DIREITOS_CREDITORIOS_DESCONTADOS - - OUTROS_TITULOS_DESCONTADOS - description: 'Modalidades de direitos creditórios descontados ofertados para pessoas naturais, conforme Circular 4015-Bacen. Direito creditório descontado é a antecipação de créditos relativos por ex. ao: desconto de duplicatas, desconto de cheques,antecipação de fatura de cartão de crédito' - example: DESCONTO_DUPLICATAS - fees: - $ref: '#/components/schemas/PersonalInvoiceFinancingsFees' - interestRates: - type: array - items: - $ref: '#/components/schemas/PersonalInvoiceFinancingsInterestRates' - minItems: 1 - description: Lista que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios da Modalidade de crédito. - requiredWarranties: - type: array - items: - $ref: '#/components/schemas/RequiredWarranty' - minItems: 1 - maxItems: 14 - description: Lista das garantias exigidas - termsConditions: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Campo aberto para informar as condições contratuais relativas à Modalidade de Financiamentos para pessoa natural informada. Pode ser informada a URL referente ao endereço onde constam as condições informadas. Endereço eletrônico de acesso ao canal. - example: 'https://empresaa1.com/personal_invoice_financings' - PersonalInvoiceFinancingsFees: - type: object - description: Objeto que reúne informações de tarifas de serviços - properties: - services: - type: array - description: Lista das Tarifas cobradas sobre Serviços - items: - $ref: "#/components/schemas/InvoiceFinancingsService" - minItems: 1 - required: - - services - InvoiceFinancingsService: - type: object - required: - - name - - code - - chargingTriggerInfo - - prices - - minimum - - maximum - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 250 - description: 'Nomes das Tarifas cobradas sobre Serviços ofertados à Modalidade de direitos creditórios descontados, para pessoa natural. (Campo Livre)' - example: 'Custódia de Duplicatas' - code: - type: string - pattern: '[\w\W\s]*' - maxLength: 100 - description: 'Sigla de identificação do serviço relacionado à Modalidade de direitos creditórios descontados, para pessoa natural. Campo aberto' - example: 'NA' - chargingTriggerInfo: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: 'Fatores geradores de cobrança que incidem sobre as Modalidades de direitos creditórios descontados, para pessoa natural. Campo Livre' - example: '5% do valor do contrato' - prices: - type: array - items: - $ref: '#/components/schemas/Price' - minItems: 4 - maxItems: 4 - description: Lista distribuição preços tarifas de serviços - minimum: - $ref: '#/components/schemas/MinimumPrice' - maximum: - $ref: '#/components/schemas/MaximumPrice' - PersonalInvoiceFinancingsInterestRates: - type: object - required: - - referentialRateIndexer - - rate - - applications - - minimumRate - - maximumRate - properties: - referentialRateIndexer: - type: string - enum: - - SEM_INDEXADOR_TAXA - - PRE_FIXADO - - POS_FIXADO_TR_TBF - - POS_FIXADO_TJLP - - POS_FIXADO_LIBOR - - POS_FIXADO_TLP - - OUTRAS_TAXAS_POS_FIXADAS - - FLUTUANTES_CDI - - FLUTUANTES_SELIC - - OUTRAS_TAXAS_FLUTUANTES - - INDICES_PRECOS_IGPM - - INDICES_PRECOS_IPCA - - INDICES_PRECOS_IPCC - - OUTROS_INDICES_PRECO - - CREDITO_RURAL_TCR_PRE - - CREDITO_RURAL_TCR_POS - - CREDITO_RURAL_TRFC_PRE - - CREDITO_RURAL_TRFC_POS - - OUTROS_INDEXADORES - description: 'Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040' - example: PRE_FIXADO - rate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: | - Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%) A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.150000' - minLength: 8 - maxLength: 8 - applications: - type: array - description: Lista das faixas de cobrança da taxa efetiva de remuneração - items: - $ref: "#/components/schemas/ApplicationRate" - minItems: 4 - maxItems: 4 - minimumRate: - type: string - description: | - Percentual mínimo cobrado (taxa efetiva) no mês de referência, para os Direitos Creditórios Descontados contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.15. Este valor representa 15%. O valor 1 representa 100%) - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - example: '0.088900' - maximumRate: - type: string - description: | - Percentual máximo cobrado (taxa efetiva) no mês de referência, para os Direitos Creditórios Descontados contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.15. Este valor representa 15%. O valor 1 representa 100%) - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - example: '0.686500' - ResponseBusinessInvoiceFinancings: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/BusinessInvoiceFinancingsBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - BusinessInvoiceFinancingsBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 30 - description: Nome da marca. - example: Marca A - companies: - type: array - items: - $ref: '#/components/schemas/BusinessInvoiceFinancingsCompanies' - minItems: 1 - description: Companies traz uma lista de todas as instituições da Marca - BusinessInvoiceFinancingsCompanies: - type: object - required: - - name - - cnpjNumber - - businessInvoiceFinancings - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - businessInvoiceFinancings: - type: array - items: - $ref: '#/components/schemas/BusinessInvoiceFinancings' - minItems: 1 - maxItems: 5 - description: Lista de Modalidades de Direitos Creditórios Descontados - BusinessInvoiceFinancings: - type: object - required: - - type - - fees - - interestRates - - requiredWarranties - - termsConditions - properties: - type: - type: string - enum: - - DESCONTO_DUPLICATAS - - DESCONTO_CHEQUES - - ANTECIPACAO_FATURA_CARTAO_CREDITO - - OUTROS_DIREITOS_CREDITORIOS_DESCONTADOS - - OUTROS_TITULOS_DESCONTADOS - description: 'Modalidades de direitos creditórios descontados ofertados para pessoas Jurídicas, conforme Circular 4015-Bacen. Direito creditório descontado é a antecipação de créditos relativos por ex. ao: desconto de duplicatas, desconto de cheques,antecipação de fatura de cartão de crédito' - fees: - $ref: '#/components/schemas/BusinessInvoiceFinancingsFees' - interestRates: - type: array - items: - $ref: '#/components/schemas/BusinessInvoiceFinancingsInterestRates' - minItems: 1 - description: Lista que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios da Modalidade de crédito - requiredWarranties: - type: array - items: - $ref: '#/components/schemas/RequiredWarranty' - description: Lista das garantias exigidas - minItems: 1 - maxItems: 14 - termsConditions: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Campo aberto para informar as condições contratuais relativas à Modalidade de Financiamentos para pessoa jurídica informada. Pode ser informada a URL referente ao endereço onde constam as condições informadas. Endereço eletrônico de acesso ao canal. - example: 'https://empresaa1.com/personal_invoice_financings' - BusinessInvoiceFinancingsFees: - type: object - description: Objeto que reúne informações de tarifas de serviços - required: - - services - properties: - services: - type: array - items: - $ref: "#/components/schemas/InvoiceFinancingsService" - minItems: 1 - description: Lista das Tarifas cobradas sobre Serviços - BusinessInvoiceFinancingsInterestRates: - type: object - required: - - referentialRateIndexer - - rate - - applications - - minimumRate - - maximumRate - properties: - referentialRateIndexer: - type: string - enum: - - SEM_INDEXADOR_TAXA - - PRE_FIXADO - - POS_FIXADO_TR_TBF - - POS_FIXADO_TJLP - - POS_FIXADO_LIBOR - - POS_FIXADO_TLP - - OUTRAS_TAXAS_POS_FIXADAS - - FLUTUANTES_CDI - - FLUTUANTES_SELIC - - OUTRAS_TAXAS_FLUTUANTES - - INDICES_PRECOS_IGPM - - INDICES_PRECOS_IPCA - - INDICES_PRECOS_IPCC - - OUTROS_INDICES_PRECO - - CREDITO_RURAL_TCR_PRE - - CREDITO_RURAL_TCR_POS - - CREDITO_RURAL_TRFC_PRE - - CREDITO_RURAL_TRFC_POS - - OUTROS_INDEXADORES - description: 'Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040' - example: PRE_FIXADO - rate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: | - Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%) A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - example: '0.150000' - minLength: 8 - maxLength: 8 - applications: - type: array - description: Lista das faixas de cobrança da taxa efetiva de remuneração - items: - $ref: "#/components/schemas/ApplicationRate" - minItems: 4 - maxItems: 4 - minimumRate: - type: string - description: | - Percentual mínimo cobrado (taxa efetiva) no mês de referência, para os Direitos Creditórios Descontados contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.15. Este valor representa 15%. O valor 1 representa 100%) - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - example: '0.150000' - maximumRate: - type: string - description: | - Percentual máximo cobrado (taxa efetiva) no mês de referência, para os Direitos Creditórios Descontados contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.15. Este valor representa 15%. O valor 1 representa 100%) - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - example: '0.686500' - ResponseBusinessUnarrangedAccountOverdraft: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/BusinessUnarrangedAccountOverdraftBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - BusinessUnarrangedAccountOverdraftBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 80 - description: Nome da Marca reportada pelo participante do Open Finance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes. - example: "Organização A" - companies: - type: array - maxItems: 700 - items: - $ref: '#/components/schemas/BusinessUnarrangedAccountOverdraftCompany' - description: Companies traz uma lista de todas as instituições da Marca - BusinessUnarrangedAccountOverdraftCompany: - type: object - required: - - name - - cnpjNumber - - businessUnarrangedAccountOverdraft - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - businessUnarrangedAccountOverdraft: - type: array - maxItems: 20 - items: - $ref: '#/components/schemas/BusinessUnarrangedAccountOverdraft' - description: Lista de adiantamento a depositante - BusinessUnarrangedAccountOverdraft: - type: object - required: - - fees - - interestRate - - termsConditions - properties: - fees: - $ref: '#/components/schemas/BusinessUnarrangedAccountOverdraftFee' - interestRates: - type: array - maxItems: 20 - items: - $ref: '#/components/schemas/UnarrangedAccountOverdraftRate' - minItems: 1 - description: Lista que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios da Modalidade de crédito - termsConditions: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Campo aberto para informar as condições contratuais relativas à Modalidade de Adiantamento a depositante para pessoa natural. Pode ser informada a URL referente ao endereço onde constam as condições informadas. Endereço eletrônico de acesso ao canal. - example: 'https://empresaa1.com/business_unarranged_account_overdraft' - BusinessUnarrangedAccountOverdraftFee: - type: object - description: Objeto que reúne informações de tarifas de serviços - required: - - services - properties: - services: - type: array - items: - $ref: '#/components/schemas/UnarrangedAccountOverdraftService' - minItems: 1 - maxItems: 31 - description: Lista das Tarifas cobradas sobre Serviços Prioritários - UnarrangedAccountOverdraftService: - type: object - required: - - name - - code - - chargingTriggerInfo - - prices - - minimum - - maximum - properties: - name: - type: string - enum: - - CONCESSAO_ADIANTAMENTO_DEPOSITANTE - default: CONCESSAO_ADIANTAMENTO_DEPOSITANTE - description: 'Nome da Tarifa cobrada sobre Serviço que incide sobre Adiantamento a depositante, para pessoa jurídica.' - code: - type: string - enum: - - ADIANT_DEPOSITANTE - default: ADIANT_DEPOSITANTE - description: 'Sigla de identificação do serviço relacionado à Modalidade de Adiantamento a depositante, para pessoa jurídica.' - chargingTriggerInfo: - type: string - maxLength: 2000 - pattern: '[\w\W\s]*' - description: 'Fato gerador de cobrança que incide sobre a Modalidade de Adiantamento a depositante informada, para pessoa jurídica.' - prices: - type: array - items: - $ref: '#/components/schemas/Price' - minItems: 4 - maxItems: 4 - description: lista das faixas dos valores de tarfas cobradas - minimum: - $ref: '#/components/schemas/MinimumPrice' - maximum: - $ref: '#/components/schemas/MaximumPrice' - example: - name: CONCESSAO_ADIANTAMENTO_DEPOSITANTE - code: ADIANT_DEPOSITANTE - chargingTriggerInfo: Levantamento de informações e avaliação de viabilidade e de riscos para a concessão de crédito em caráter emergencial para cobertura de saldo devedor em conta de depósitos à vista e de excesso sobre o limite previamente pactuado de cheque especial, cobrada no máximo uma vez nos últimos trinta dias - prices: - - interval: 1_FAIXA - value: "500.00" - currency: BRL - customers: - rate: "0.150000" - - interval: 2_FAIXA - value: "860.00" - currency: BRL - customers: - rate: "0.350000" - - interval: 3_FAIXA - value: "1090.40" - currency: "BRL" - customers: - rate: "0.200000" - - interval: 4_FAIXA - value: "2100.00" - currency: BRL - customers: - rate: "0.300000" - minimum: - value: "430.00" - currency: "BRL" - maximum: - value: "2200.00" - currency: "BRL" - UnarrangedAccountOverdraftRate: - description: Tarifas cobradas sobre Serviços ofertados - type: object - required: - - referentialRateIndexer - - rate - - applications - - minimumRate - - maximumRate - properties: - referentialRateIndexer: - $ref: '#/components/schemas/ReferentialRateIndexer' - rate: - type: string - description: | - Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%). A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - example: '0.150000' - applications: - description: Lista das faixas de cobrança da taxa efetiva de remuneração. - type: array - items: - $ref: '#/components/schemas/ApplicationRate' - minItems: 4 - maxItems: 4 - minimumRate: - type: string - description: | - Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o crédito contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - maximumRate: - type: string - description: | - Percentual máximo cobrado (taxa efetiva) no mês de referência, para o crédito contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - example: - referentialRateIndexer: "SEM_INDEXADOR_TAXA" - rate: "0.650000" - applications: - - interval: "1_FAIXA" - indexer: - rate: "0.018700" - customers: - rate: "0.150000" - - interval: "2_FAIXA" - indexer: - rate: "0.290000" - customers: - rate: "0.350000" - - interval: "3_FAIXA" - indexer: - rate: "0.360000" - customers: - rate: "0.200000" - - interval: "4_FAIXA" - indexer: - rate: "0.799000" - customers: - rate: "0.300000" - minimumRate: "0.005600" - maximumRate: "0.856500" - ResponsePersonalUnarrangedAccountOverdraft: - type: object - required: - - data - - links - - meta - properties: - data: - type: object - required: - - brand - properties: - brand: - $ref: '#/components/schemas/PersonalUnarrangedAccountOverdraftBrand' - links: - $ref: '#/components/schemas/Links' - meta: - $ref: '#/components/schemas/Meta' - PersonalUnarrangedAccountOverdraftBrand: - type: object - required: - - name - - companies - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 80 - description: Nome da Marca reportada pelo participante do Open Finance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes. - example: "Organização A" - companies: - type: array - maxItems: 700 - items: - $ref: '#/components/schemas/PersonalUnarrangedAccountOverdraftCompany' - description: Companies traz uma lista de todas as instituições da Marca - PersonalUnarrangedAccountOverdraftCompany: - type: object - required: - - name - - cnpjNumber - - personalUnarrangedAccountOverdraft - properties: - name: - type: string - description: Nome da Instituição, pertencente à marca, responsável pela modalidade de Empréstimos. p.ex.'Empresa da Organização A' - maxLength: 80 - pattern: '[\w\W\s]*' - example: 'Empresa A1' - cnpjNumber: - type: string - pattern: '^(\d{14})$|^NA$' - description: CNPJ - maxLength: 14 - example: "50685362000135" - urlComplementaryList: - type: string - pattern: '[\w\W\s]*' - maxLength: 1024 - description: | - URL do link que conterá a lista complementar com os nomes e CNPJs agrupados sob o mesmo cnpjNumber. Os contidos nessa lista possuem as mesmas características para produtos e serviços. Endereço eletrônico de acesso ao canal. Será obrigatoriamente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada. - Restrição: Será obrigatorimente preenchido se houver lista complementar com os nomes e CNPJs a ser disponibilizada - example: 'https://empresadaorganizacaoa.com/complementarylist' - personalUnarrangedAccountOverdraft: - type: array - maxItems: 20 - items: - $ref: '#/components/schemas/PersonalUnarrangedAccountOverdraft' - description: Lista de produtos e serviços referente adiantamento a depositante - PersonalUnarrangedAccountOverdraft: - type: object - required: - - fees - - termsConditions - properties: - fees: - $ref: '#/components/schemas/PersonalUnarrangedAccountOverdraftFee' - interestRates: - type: array - items: - $ref: '#/components/schemas/UnarrangedAccountOverdraftRate' - minItems: 1 - description: Lista que traz o conjunto de informações necessárias para demonstrar a distribuição de frequências das taxas de juros remuneratórios da Modalidade de crédito - termsConditions: - type: string - pattern: '[\w\W\s]*' - maxLength: 2000 - description: Campo aberto para informar as condições contratuais relativas à Modalidade de Adiantamento a depositante para pessoa natural. Pode ser informada a URL referente ao endereço onde constam as condições informadas. Endereço eletrônico de acesso ao canal. - example: 'https://empresaa1.com/personal_unarranged_account_overdraft' - PersonalUnarrangedAccountOverdraftFee: - type: object - description: Objeto que reúne informações de tarifas de serviços - required: - - priorityServices - properties: - priorityServices: - type: array - maxItems: 20 - items: - $ref: '#/components/schemas/UnarrangedAccountOverdraftService' - minItems: 1 - description: Lista das Tarifas cobradas sobre Serviços Prioritários - Price: - type: object - required: - - interval - - value - - currency - - customers - properties: - interval: - $ref: '#/components/schemas/PriceIntervals' - value: - type: string - pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' - maxLength: 12 - x-cds-type: AmountString - description: | - Valor da mediana de cada faixa relativa ao serviço ofertado, informado no período, conforme Res nº 32 BCB, 2020. p.ex. '45.00' (representa um valor monetário. p.ex: 1547368.92. Este valor, considerando que a moeda seja BRL, significa R$ 1.547.368,92. O único separador presente deve ser o '.' (ponto) para indicar a casa decimal. Não deve haver separador de milhar) - example: '2000.00' - currency: - $ref: '#/components/schemas/Currency' - customers: - $ref: '#/components/schemas/Customer' - PersonalAccountPrice: - type: object - required: - - interval - - value - - currency - - customers - properties: - interval: - $ref: '#/components/schemas/PersonalAccountPriceIntervals' - value: - type: string - pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' - maxLength: 12 - x-cds-type: AmountString - description: | - Valor da mediana de cada faixa relativa ao serviço ofertado, informado no período, conforme Res nº 32 BCB, 2020. p.ex. '45.00' (representa um valor monetário. p.ex: 1547368.92. Este valor, considerando que a moeda seja BRL, significa R$ 1.547.368,92. O único separador presente deve ser o '.' (ponto) para indicar a casa decimal. Não deve haver separador de milhar) - example: '2000.00' - currency: - $ref: '#/components/schemas/Currency' - customers: - $ref: '#/components/schemas/Customer' - MonthlyPrice: - type: object - required: - - interval - - monthlyFee - - currency - - customers - properties: - interval: - $ref: '#/components/schemas/PersonalAccountPriceIntervals' - monthlyFee: - type: string - pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' - maxLength: 12 - x-cds-type: AmountString - description: | - Valor da mediana de cada faixa relativa ao serviço ofertado, informado no período, conforme Res nº 32 BCB, 2020. p.ex. ''45.00'' - (representa um valor monetário. p.ex: 1547368.92. Este valor, considerando que a moeda seja BRL, significa R$ 1.547.368,92. O único separador presente deve ser o ''.'' (ponto) para indicar a casa decimal. Não deve haver separador de milhar) - example: '2000.00' - currency: - $ref: "#/components/schemas/Currency" - customers: - $ref: '#/components/schemas/Customer' - MinimumPrice: - type: object - required: - - value - - currency - properties: - value: - type: string - pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' - maxLength: 12 - x-cds-type: AmountString - description: Valor mínimo apurado para a tarifa de serviços sobre a base de clientes no mês de referência - example: '1350.00' - currency: - $ref: "#/components/schemas/Currency" - MaximumPrice: - type: object - required: - - value - - currency - properties: - value: - type: string - pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' - maxLength: 12 - x-cds-type: AmountString - description: Valor máximo apurado para a tarifa de serviços sobre a base de clientes no mês de referência - example: '8800.00' - currency: - $ref: "#/components/schemas/Currency" - Customer: - type: object - required: - - rate - properties: - rate: - type: string - description: | - Percentual de clientes em cada faixa. - pattern: '^\d{1}\.\d{6}$' - example: '0.150000' - minLength: 8 - maxLength: 8 - MinimumBalance: - type: object - required: - - value - - currency - properties: - value: - type: string - maxLength: 12 - pattern: '^((\d{1,9}\.\d{2}){1}|NA)$' - description: 'Saldo mínimo exigido nos Termos e condições contratuais, que regem as contas comercializadas.' - example: '200.00' - currency: - $ref: "#/components/schemas/Currency" - Currency: - type: string - pattern: '^(\w{3}){1}$' - maxLength: 3 - x-cds-type: CurrencyString - description: 'Moeda referente ao valor mínimo da Tarifa, segundo modelo ISO-4217' - example: BRL - InterestRate: - type: object - required: - - referentialRateIndexer - - rate - - applications - - minimumRate - - maximumRate - properties: - referentialRateIndexer: - $ref: '#/components/schemas/ReferentialRateIndexer' - rate: - type: string - description: | - Percentual que incide sobre a composição das taxas de juros remuneratórios. (representa uma porcentagem Ex: 0.15 (O valor ao lado representa 15%. O valor '1 'representa 100%). A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%) - pattern: '^\d{1}\.\d{6}$' - minLength: 8 - maxLength: 8 - example: '0.150000' - applications: - type: array - description: Lista distribuição percentuais relativos à taxa de juros remuneratórios - items: - $ref: "#/components/schemas/ApplicationRate" - minItems: 4 - maxItems: 4 - minimumRate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: 'Percentual mínimo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - minLength: 8 - maxLength: 8 - example: '0.045600' - maximumRate: - type: string - pattern: '^\d{1}\.\d{6}$' - description: 'Percentual máximo cobrado (taxa efetiva) no mês de referência, para o Financiamento contratado A apuração pode acontecer com até 4 casas decimais. O preenchimento deve respeitar as 4 casas decimais, mesmo que venham preenchidas com zeros (representação de porcentagem p.ex: 0.1500. Este valor representa 15%. O valor 1 representa 100%)' - minLength: 8 - maxLength: 8 - example: '0.686500' - ReferentialRateIndexer: - type: string - description: | - Tipos de taxas referenciais ou indexadores, conforme Anexo 5: Taxa referencial ou Indexador (Indx), do Documento 3040 - enum: - - SEM_INDEXADOR_TAXA - - PRE_FIXADO - - POS_FIXADO_TR_TBF - - POS_FIXADO_TJLP - - POS_FIXADO_LIBOR - - POS_FIXADO_TLP - - OUTRAS_TAXAS_POS_FIXADAS - - FLUTUANTES_CDI - - FLUTUANTES_SELIC - - OUTRAS_TAXAS_FLUTUANTES - - INDICES_PRECOS_IGPM - - INDICES_PRECOS_IPCA - - INDICES_PRECOS_IPCC - - OUTROS_INDICES_PRECO - - CREDITO_RURAL_TCR_PRE - - CREDITO_RURAL_TCR_POS - - CREDITO_RURAL_TRFC_PRE - - CREDITO_RURAL_TRFC_POS - - OUTROS_INDEXADORES - example: 'SEM_INDEXADOR_TAXA' - PersonalCreditCard: - type: object - required: - - name - - identification - - rewardsProgram - - fees - - interest - - termsConditions - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 50 - description: Denominação/Identificação do nome da conta (cartão de crédito) - example: Cartão Universitário - identification: - $ref: '#/components/schemas/CreditCardIdentification' - rewardsProgram: - $ref: '#/components/schemas/CreditCardRewardsProgram' - fees: - type: object - description: Objeto que reúne informações de tarifas de serviços - required: - - services - properties: - services: - type: array - description: Lista das Tarifas cobradas sobre Serviço relacionadas a Modalidade de Pagamento Pós-Pagas - items: - $ref: '#/components/schemas/CreditCardService' - minItems: 1 - maxItems: 9 - interest: - $ref: '#/components/schemas/CreditCardInterest' - termsConditions: - $ref: '#/components/schemas/CreditCardTermsConditions' - BusinessCreditCard: - type: object - required: - - name - - identification - - rewardsProgram - - fees - - interest - - termsConditions - properties: - name: - type: string - pattern: '[\w\W\s]*' - maxLength: 50 - description: Denominação/Identificação do nome da conta (cartão de crédito) - example: Cartão Vantagens - identification: - $ref: '#/components/schemas/CreditCardIdentification' - rewardsProgram: - $ref: '#/components/schemas/CreditCardRewardsProgram' - fees: - type: object - description: Objeto que reúne informações de tarifas de serviços - required: - - services - properties: - services: - type: array - description: Lista das Tarifas cobradas sobre Serviço relacionadas a Modalidade de Pagamento Pós-Pagas - items: - $ref: '#/components/schemas/CreditCardService' - minItems: 1 - maxItems: 9 - interest: - $ref: '#/components/schemas/CreditCardInterest' - termsConditions: - $ref: '#/components/schemas/CreditCardTermsConditions' - Links: - type: object - properties: - self: - type: string - maxLength: 2000 - description: URL da página atualmente requisitada - pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' - example: 'https://api.banco.com.br/open-banking/products-services/v1/resource' - first: - type: string - maxLength: 2000 - description: URL da primeira página de registros - pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' - example: 'https://api.banco.com.br/open-banking/products-services/v1/resource' - prev: - type: string - maxLength: 2000 - description: URL da página anterior de registros - pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' - next: - type: string - maxLength: 2000 - description: URL da próxima página de registros - pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' - last: - type: string - maxLength: 2000 - description: URL da última página de registros - pattern: '^(https:\/\/)?(www\.)?[-a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/\/=]*)$' - example: 'https://api.banco.com.br/open-banking/products-services/v1/resource' - Meta: - type: object - properties: - totalRecords: - type: integer - description: Total de registros encontrados - example: 1 - totalPages: - type: integer - description: Total de páginas para os registros encontrados - example: 1 - required: - - totalRecords - - totalPages - ResponseErrorMetaSingle: - type: object - required: - - errors - properties: - errors: - type: array - minItems: 1 - maxItems: 13 - items: - type: object - required: - - code - - title - - detail - properties: - code: - description: Código de erro específico do endpoint - type: string - pattern: '[\w\W\s]*' - maxLength: 255 - title: - description: Título legível por humanos deste erro específico - type: string - pattern: '[\w\W\s]*' - maxLength: 255 - detail: - description: Descrição legível por humanos deste erro específico - type: string - pattern: '[\w\W\s]*' - maxLength: 2048 - meta: - type: object - description: Meta informações referente à API requisitada. - required: - - requestDateTime - properties: - requestDateTime: - description: 'Data e hora da consulta, conforme especificação RFC-3339, formato UTC.' - type: string - maxLength: 20 - format: date-time - example: '2021-05-21T08:30:00Z' - ResponseError: - type: object - required: - - errors - properties: - errors: - type: array - minItems: 1 - maxItems: 13 - items: - type: object - required: - - code - - title - - detail - properties: - code: - description: Código de erro específico do endpoint - type: string - pattern: '[\w\W\s]*' - maxLength: 255 - title: - description: Título legível por humanos deste erro específico - type: string - pattern: '[\w\W\s]*' - maxLength: 255 - detail: - description: Descrição legível por humanos deste erro específico - type: string - pattern: '[\w\W\s]*' - maxLength: 2048 - meta: - type: object - description: Meta informações referente à API requisitada. - required: - - totalRecords - - totalPages - - requestDateTime - properties: - totalRecords: - type: integer - format: int32 - description: Número total de registros no resultado - example: 1 - totalPages: - type: integer - format: int32 - description: Número total de páginas no resultado - example: 1 - securitySchemes: - APIKey1: - name: API Key - type: apiKey - in: query - APIKey2: - name: API Key - type: apiKey - in: query - parameters: - page: - name: page - in: query - description: Número da página que está sendo requisitada (o valor da primeira página é 1). - schema: - type: integer - format: int32 - default: 1 - minimum: 1 - maximum: 2147483647 - pageSize: - name: page-size - in: query - description: Quantidade total de registros por páginas. - schema: - type: integer - format: int32 - default: 25 - minimum: 1 - maximum: 1000 - responses: - BadRequest: - description: A requisição foi malformada, omitindo atributos obrigatórios, seja no payload ou através de atributos na URL. - content: - application/json; charset=utf-8: - schema: - $ref: '#/components/schemas/ResponseError' - NotFound: - description: O recurso solicitado não existe ou não foi implementado. - content: - application/json; charset=utf-8: - schema: - $ref: '#/components/schemas/ResponseError' - MethodNotAllowed: - description: O consumidor tentou acessar o recurso com um método não suportado. - content: - application/json; charset=utf-8: - schema: - $ref: '#/components/schemas/ResponseError' - TooManyRequests: - description: A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido. - content: - application/json; charset=utf-8: - schema: - $ref: '#/components/schemas/ResponseError' - InternalServerError: - description: Ocorreu um erro no gateway da API ou no microsserviço. - content: - application/json; charset=utf-8: - schema: - $ref: '#/components/schemas/ResponseError' - GatewayTimeout: - description: GATEWAY TIMEOUT - A requisição não foi atendida dentro do tempo limite estabelecido. - content: - application/json; charset=utf-8: - schema: - $ref: '#/components/schemas/ResponseError' - SiteIsOverloaded: - description: O site está sobrecarregado e a operação foi recusada, pois foi atingido o limite máximo de TPS global, neste momento. - content: - application/json; charset=utf-8: - schema: - $ref: '#/components/schemas/ResponseErrorMetaSingle' - Default: - description: '\-' - content: - application/json; charset=utf-8: - schema: - $ref: '#/components/schemas/ResponseError' - \ No newline at end of file