Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v1.0.3 #15

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

v1.0.3 #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1b53440
feat: updated endpoint list
trestini Apr 28, 2023
03dc2f9
fix: remove field status from opendata reports
trestini Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 54 additions & 51 deletions openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,15 +379,13 @@ paths:
type: array
maxItems: 5000
items:
$ref: "#/components/schemas/ReportResponse"
$ref: "#/components/schemas/OpendataReportResponse"
examples:
Todos Processados:
description: Esta seria a resposta para uma solicitação com o exemplo "Request Válido" da documentação. O payload da resposta vem na mesma ordem do array da solicitação. Todos registros que chegarem com o atributo _correlationId_ o receberão de volta. Uma vez que todos os registros foram validados, o status de retorno é o 200.
value:
- reportId: 424ad55c-36cc-4077-b85e-c22ea984cc4a
status: ACCEPTED
- reportId: 4095388d-f44f-499a-a9a7-2dbffce1bb8a
status: ACCEPTED

"207":
description: |
Expand All @@ -400,31 +398,25 @@ paths:
type: array
maxItems: 5000
items:
$ref: "#/components/schemas/ReportResponse"
$ref: "#/components/schemas/OpendataReportResponse"
examples:
"Primeiro registro com falha":
description: |
No caso apresentado é o resultado onde o exemplo "Request com falha" foi enviado: o registro com o _fapiInteractionId_ `d78fc4e5-37ca-4da3-adf2-9b082bf92280` apresentou uma falha na validação, mas os demais foram enviados para processamento. Como um dos registros não foi validado, o status de retorno passa a ser 207, e os demais registros são processados normalmente.
value:
- reportId: 424ad55c-36cc-4077-b85e-c22ea984cc4a
status: DISCARDED
message: "Missing fields: 'uri'"
message: "Missing fields: 'processTimespan'"
- reportId: 4095388d-f44f-499a-a9a7-2dbffce1bb8a
status: ACCEPTED
- reportId: 0f3fcceb-39f6-41b4-a75d-8444244bd836
status: ACCEPTED
"Todos registros com falha":
description: |
Neste caso, parte-se da premissa que todos os registros foram enviados com algum campo faltante. Nesse caso, todos vão falhar na etapa de validação, mas mesmo quando todos os registros falham, o status de retorno é o 207.
value:
- reportId: 424ad55c-36cc-4077-b85e-c22ea984cc4a
status: DISCARDED
message: "Missing fields: 'uri'"
message: "Missing fields: 'statusCode'"
- reportId: 4095388d-f44f-499a-a9a7-2dbffce1bb8a
status: DISCARDED
message: "Missing fields: 'additionalInfo'"
- reportId: 0f3fcceb-39f6-41b4-a75d-8444244bd836
status: DISCARDED
message: "Missing fields: 'httpMethod'"

"400":
Expand Down Expand Up @@ -713,6 +705,27 @@ components:
maxLength: 200
example: "Missing fields: 'fapiInteractionId', 'endpoint'"

OpendataReportResponse:
description: Representa os dados que serão retornados pelas operações de inclusão de reportes Opendata
additionalProperties: false
required:
- reportId
type: object
properties:
reportId:
description: Identificator único interno do reporte no formato UUID v4.
type: string
format: uuid
maxLength: 36
pattern: "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
example: "9a97c2df-b261-4fc2-aa66-d1b5168397da"
message:
description: Caso a solicitação contenha algum problema em seu formato, ou caso haja algum tipo de falha detectável no momento da requisição, esse campo trará detalhes sobre o erro ocorrido. Informações adicionais sobre os tipos de erros podem ser encontradas em https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/46170119/Troubleshooting+-+PCM
type: string
pattern: ^[- /:_.',0-9a-zA-Z]{0,200}$
maxLength: 200
example: "Missing fields: 'fapiInteractionId', 'endpoint'"

ReportStatus:
description: |
Informa o status do registro de reporte.
Expand Down Expand Up @@ -802,48 +815,54 @@ components:
type: string
example: /open-banking/consents/v2/consents
enum:
- "/token"
- "/register"
- "/register/{clientId}"
- "/token"
- "/revocation"
- "/introspection"
- "/pushed-authorization-request"
- "/revocation"
- "/open-banking/accounts/v2/accounts"
- "/open-banking/accounts/v2/accounts/{accountId}"
- "/open-banking/accounts/v2/accounts/{accountId}/balances"
- "/open-banking/accounts/v2/accounts/{accountId}/overdraft-limits"
- "/open-banking/accounts/v2/accounts/{accountId}/transactions"
- "/open-banking/accounts/v2/accounts/{accountId}/transactions-current"
- "/open-banking/consents/v2/consents"
- "/open-banking/consents/v2/consents/{consentId}"
- "/open-banking/resources/v2/resources"
- "/open-banking/customers/v2/personal/identifications"
- "/open-banking/customers/v2/business/identifications"
- "/open-banking/customers/v2/personal/qualifications"
- "/open-banking/customers/v2/business/qualifications"
- "/open-banking/customers/v2/personal/financial-relations"
- "/open-banking/customers/v2/business/financial-relations"
- "/open-banking/credit-cards-accounts/v2/accounts"
- "/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}"
- "/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/bills"
- "/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/bills/{billId}/transactions"
- "/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/limits"
- "/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/transactions"
- "/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/transactions-current"
- "/open-banking/customers/v2/business/financial-relations"
- "/open-banking/customers/v2/business/identifications"
- "/open-banking/customers/v2/business/qualifications"
- "/open-banking/customers/v2/personal/financial-relations"
- "/open-banking/customers/v2/personal/identifications"
- "/open-banking/customers/v2/personal/qualifications"
- "/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/bills"
- "/open-banking/credit-cards-accounts/v2/accounts/{creditCardAccountId}/bills/{billId}/transactions"
- "/open-banking/accounts/v2/accounts"
- "/open-banking/accounts/v2/accounts/{accountId}"
- "/open-banking/accounts/v2/accounts/{accountId}/balances"
- "/open-banking/accounts/v2/accounts/{accountId}/transactions"
- "/open-banking/accounts/v2/accounts/{accountId}/transactions-current"
- "/open-banking/accounts/v2/accounts/{accountId}/overdraft-limits"
- "/open-banking/loans/v2/contracts"
- "/open-banking/loans/v2/contracts/{contractId}"
- "/open-banking/loans/v2/contracts/{contractId}/warranties"
- "/open-banking/loans/v2/contracts/{contractId}/payments"
- "/open-banking/loans/v2/contracts/{contractId}/scheduled-instalments"
- "/open-banking/financings/v2/contracts"
- "/open-banking/financings/v2/contracts/{contractId}"
- "/open-banking/financings/v2/contracts/{contractId}/warranties"
- "/open-banking/financings/v2/contracts/{contractId}/payments"
- "/open-banking/financings/v2/contracts/{contractId}/scheduled-instalments"
- "/open-banking/financings/v2/contracts/{contractId}/warranties"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/warranties"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/payments"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/scheduled-instalments"
- "/open-banking/invoice-financings/v2/contracts"
- "/open-banking/invoice-financings/v2/contracts/{contractId}"
- "/open-banking/invoice-financings/v2/contracts/{contractId}/warranties"
- "/open-banking/invoice-financings/v2/contracts/{contractId}/payments"
- "/open-banking/invoice-financings/v2/contracts/{contractId}/scheduled-instalments"
- "/open-banking/invoice-financings/v2/contracts/{contractId}/warranties"
- "/open-banking/loans/v2/contracts"
- "/open-banking/loans/v2/contracts/{contractId}"
- "/open-banking/loans/v2/contracts/{contractId}/payments"
- "/open-banking/loans/v2/contracts/{contractId}/scheduled-instalments"
- "/open-banking/loans/v2/contracts/{contractId}/warranties"
- "/open-banking/payments/v1/consents"
- "/open-banking/payments/v1/consents/{consentId}"
- "/open-banking/payments/v1/pix/payments"
Expand All @@ -852,12 +871,6 @@ components:
- "/open-banking/payments/v2/consents/{consentId}"
- "/open-banking/payments/v2/pix/payments"
- "/open-banking/payments/v2/pix/payments/{paymentId}"
- "/open-banking/resources/v2/resources"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/payments"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/scheduled-instalments"
- "/open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/warranties"

OpendataReportEndpoints:
description: |
Expand All @@ -882,16 +895,6 @@ components:
- "/open-banking/channels/v1/phone-channels"
- "/open-banking/channels/v1/banking-agents"
- "/open-banking/channels/v1/shared-automated-teller-machines"
- "/open-banking/capitalization-bonds/v1/bonds"
- "/open-banking/investments/v1/funds"
- "/open-banking/exchange/v1/online-rates"
- "/open-banking/exchange/v1/vet-values"
- "/open-banking/acquiring-services/v1/personals"
- "/open-banking/acquiring-services/v1/businesses"
- "/open-banking/pension/v1/risk-coverages"
- "/open-banking/insurance/v1/automotives"
- "/open-banking/insurance/v1/homes"
- "/open-banking/insurance/v1/personals"

AdditionalInfo:
description: Informações adicionais sobre o reporte deste endpoint/método. Possui característica variável. As regras de preenchimento estão na documentação funcional em https://openfinancebrasil.atlassian.net/wiki/spaces/OF/pages/37879861/Reporte#additionalInfo. Atenção especial na tabela Excel com a listagem de endpoints em https://openfinancebrasil.atlassian.net/wiki/download/attachments/37879861/Tabela%20additionalInfo%20%E2%80%93%20campos%20contexto%20e%20obrigatoriedade%20(cliente%20server).xlsx?api=v2.
Expand Down