Relação de APIs
As tabelas abaixo documentam quais APIs são contabilizadas nas métricas para cobrança por consumo.
Fase 1
| Produto | Método | Endpoint |
|---|---|---|
| Canais de Atendimento | GET | /open-banking/channels/v2/banking-agents |
| GET | /open-banking/channels/v2/branches | |
| GET | /open-banking/channels/v2/electronic-channels | |
| GET | /open-banking/channels/v2/phone-channels | |
| GET | /open-banking/channels/v2/shared-automated-teller-machines | |
| Contas | GET | /open-banking/opendata-accounts/v1/personal-accounts |
| Acquiring Services | GET | /open-banking/opendata-acquiring-services/v1/businesses |
| GET | /open-banking/opendata-acquiring-services/v1/personals | |
| Capitalização | GET | /open-banking/opendata-capitalization/v2/bonds |
| Cartão de Crédito | GET | /open-banking/opendata-creditcards/v1/business-credit-cards |
| GET | /open-banking/opendata-creditcards/v1/personal-credit-cards | |
| Exchange | GET | /open-banking/opendata-exchange/v1/online-rates |
| GET | /open-banking/opendata-exchange/v1/vet-rates | |
| GET | /open-banking/opendata-exchange/v1/vet-values | |
| Financings | GET | /open-banking/opendata-financings/v1/business-financings |
| GET | /open-banking/opendata-financings/v1/personal-financings | |
| Insurance | GET | /open-banking/opendata-insurance/v2/personals |
| Investments | GET | /open-banking/opendata-investments/v1/bank-fixed-incomes |
| GET | /open-banking/opendata-investments/v1/credit-fixed-incomes | |
| GET | /open-banking/opendata-investments/v1/funds | |
| GET | /open-banking/opendata-investments/v1/treasure-titles | |
| GET | /open-banking/opendata-investments/v1/variable-incomes | |
| Invoice Financings | GET | /open-banking/opendata-invoicefinancings/v1/business-invoice-financings |
| GET | /open-banking/opendata-invoicefinancings/v1/personal-invoice-financings | |
| Loans | GET | /open-banking/opendata-loans/v1/business-loans |
| GET | /open-banking/opendata-loans/v1/personal-loans | |
| Pension | GET | /open-banking/opendata-pension/v2/risk-coverages |
| GET | /open-banking/opendata-pension/v2/survival-coverages | |
| Unarranged | GET | /open-banking/opendata-unarranged/v1/business-unarranged-account-overdraft |
| GET | /open-banking/opendata-unarranged/v1/personal-unarranged-account-overdraft | |
| Produtos e Serviços | GET | /open-banking/opendata-accounts/v1/business-accounts |
| GET | /open-banking/opendata-creditcards/v1/business-credit-cards | |
| GET | /open-banking/opendata-creditcards/v1/personal-credit-cards | |
| GET | /open-banking/opendata-financings/v1/business-financings | |
| GET | /open-banking/opendata-financings/v1/personal-financings | |
| GET | /open-banking/opendata-loans/v1/business-loans | |
| GET | /open-banking/opendata-loans/v1/personal-loans | |
| GET | /open-banking/opendata-unarranged/v1/business-unarranged-account-overdraft | |
| GET | /open-banking/opendata-unarranged/v1/personal-unarranged-account-overdraft | |
| GET | /open-banking/products-services/v1/business-accounts | |
| GET | /open-banking/products-services/v1/business-credit-cards | |
| GET | /open-banking/products-services/v1/business-financings | |
| GET | /open-banking/products-services/v1/business-invoice-financings | |
| GET | /open-banking/products-services/v1/business-loans | |
| GET | /open-banking/products-services/v1/business-unarranged-account-overdraft | |
| GET | /open-banking/products-services/v1/personal-accounts | |
| GET | /open-banking/products-services/v1/personal-credit-cards | |
| GET | /open-banking/products-services/v1/personal-financings | |
| GET | /open-banking/products-services/v1/personal-invoice-financings | |
| GET | /open-banking/products-services/v1/personal-loans | |
| GET | /open-banking/products-services/v1/personal-unarranged-account-overdraft | |
| Admin | GET | /open-banking/discovery/v2/outages |
| GET | /open-banking/discovery/v2/status | |
| GET | /open-banking/admin/v2/metrics |
Fase 2
| Produto | Método | Endpoint |
|---|---|---|
| Consents | POST | /open-banking/consents/v3/consents |
| GET | /open-banking/consents/v3/consents/consentId | |
| DELETE | /open-banking/consents/v3/consents/consentId | |
| POST | /open-banking/consents/v3/consents/consentId/extends | |
| GET | /open-banking/consents/v3/consents/consentId/extensions | |
| Accounts | GET | /open-banking/accounts/v2/accounts |
| GET | /open-banking/accounts/v2/accounts/accountId | |
| GET | /open-banking/accounts/v2/accounts/accountId/balances | |
| GET | /open-banking/accounts/v2/accounts/accountId/overdraft-limits | |
| GET | /open-banking/accounts/v2/accounts/accountId/transactions | |
| GET | /open-banking/accounts/v2/accounts/accountId/transactions-current | |
| Bank Fixed Incomes | GET | /open-banking/bank-fixed-incomes/v1/investments |
| GET | /open-banking/bank-fixed-incomes/v1/investments/investmentId | |
| GET | /open-banking/bank-fixed-incomes/v1/investments/investmentId/balances | |
| GET | /open-banking/bank-fixed-incomes/v1/investments/investmentId/transactions | |
| GET | /open-banking/bank-fixed-incomes/v1/investments/investmentId/transactions-current | |
| Credit Cards Accounts | GET | /open-banking/credit-cards-accounts/v2/accounts |
| GET | /open-banking/credit-cards-accounts/v2/accounts/creditCardAccountId | |
| GET | /open-banking/credit-cards-accounts/v2/accounts/creditCardAccountId/bills | |
| GET | /open-banking/credit-cards-accounts/v2/accounts/creditCardAccountId/bills/billId/transactions | |
| GET | /open-banking/credit-cards-accounts/v2/accounts/creditCardAccountId/limits | |
| GET | /open-banking/credit-cards-accounts/v2/accounts/creditCardAccountId/limits | |
| GET | /open-banking/credit-cards-accounts/v2/accounts/creditCardAccountId/transactions | |
| GET | /open-banking/credit-cards-accounts/v2/accounts/creditCardAccountId/transactions-current | |
| Credit Cards Incomes | GET | /open-banking/credit-fixed-incomes/v1/investments |
| GET | /open-banking/credit-fixed-incomes/v1/investments/investmentId | |
| GET | /open-banking/credit-fixed-incomes/v1/investments/investmentId/balances | |
| GET | /open-banking/credit-fixed-incomes/v1/investments/investmentId/transactions | |
| GET | /open-banking/credit-fixed-incomes/v1/investments/investmentId/transactions-current | |
| Customers | GET | /open-banking/customers/v2/business/financial-relations |
| GET | /open-banking/customers/v2/business/identifications | |
| GET | /open-banking/customers/v2/business/qualifications | |
| GET | /open-banking/customers/v2/personal/financial-relations | |
| GET | /open-banking/customers/v2/personal/identifications | |
| GET | /open-banking/customers/v2/personal/qualifications | |
| Financings | GET | /open-banking/financings/v2/contracts |
| GET | /open-banking/financings/v2/contracts/contractId | |
| GET | /open-banking/financings/v2/contracts/contractId/payments | |
| GET | /open-banking/financings/v2/contracts/contractId/scheduled-instalments | |
| GET | /open-banking/financings/v2/contracts/contractId/warranties | |
| Invoice Financings | GET | /open-banking/invoice-financings/v2/contracts |
| GET | /open-banking/invoice-financings/v2/contracts/contractId | |
| GET | /open-banking/invoice-financings/v2/contracts/contractId/payments | |
| GET | /open-banking/invoice-financings/v2/contracts/contractId/scheduled-instalments | |
| GET | /open-banking/invoice-financings/v2/contracts/contractId/warranties | |
| Loans | GET | /open-banking/loans/v2/contracts |
| GET | /open-banking/loans/v2/contracts/contractId | |
| GET | /open-banking/loans/v2/contracts/contractId/payments | |
| GET | /open-banking/loans/v2/contracts/contractId/scheduled-instalments | |
| GET | /open-banking/loans/v2/contracts/contractId/warranties | |
| Resources | GET | /open-banking/resources/v3/resources |
| Treasure Titles | GET | /open-banking/treasure-titles/v1/investments |
| GET | /open-banking/treasure-titles/v1/investments/investmentId | |
| GET | /open-banking/treasure-titles/v1/investments/investmentId/balances | |
| GET | /open-banking/treasure-titles/v1/investments/investmentId/transactions | |
| GET | /open-banking/treasure-titles/v1/investments/investmentId/transactions-current | |
| Unarranged Accounts Overdraft | GET | /open-banking/unarranged-accounts-overdraft/v2/contracts |
| GET | /open-banking/unarranged-accounts-overdraft/v2/contracts/contractId | |
| GET | /open-banking/unarranged-accounts-overdraft/v2/contracts/contractId/payments | |
| GET | /open-banking/unarranged-accounts-overdraft/v2/contracts/contractId/scheduled-instalments | |
| GET | /open-banking/unarranged-accounts-overdraft/v2/contracts/contractId/warranties | |
| Variable Incomes | GET | /open-banking/variable-incomes/v1/broker-notes/brokerNoteId |
| GET | /open-banking/variable-incomes/v1/investments | |
| GET | /open-banking/variable-incomes/v1/investments/investmentId | |
| GET | /open-banking/variable-incomes/v1/investments/investmentId/balances | |
| GET | /open-banking/variable-incomes/v1/investments/investmentId/transactions | |
| GET | /open-banking/variable-incomes/v1/investments/investmentId/transactions-current |
Fase 3
| Produto | Método | Endpoint |
|---|---|---|
| Pagamentos Automáticos | POST | /open-banking/automatic-payments/v2/pix/recurring-payments |
| GET | /open-banking/automatic-payments/v2/pix/recurring-payments | |
| GET | /open-banking/automatic-payments/v2/pix/recurring-payments/recurringPaymentId | |
| PATCH | /open-banking/automatic-payments/v2/pix/recurring-payments/recurringPaymentId | |
| POST | /open-banking/automatic-payments/v2/recurring-consents | |
| GET | /open-banking/automatic-payments/v2/recurring-consents/recurringConsentId | |
| PATCH | /open-banking/automatic-payments/v2/recurring-consents/recurringConsentId | |
| Vínculo de Dispositivo | POST | /open-banking/enrollments/v2/consents/consentId/authorise |
| POST | /open-banking/enrollments/v2/enrollments | |
| GET | /open-banking/enrollments/v2/enrollments/enrollmentId | |
| PATCH | /open-banking/enrollments/v2/enrollments/enrollmentId | |
| POST | /open-banking/enrollments/v2/enrollments/enrollmentId/fido-registration | |
| POST | /open-banking/enrollments/v2/enrollments/enrollmentId/fido-registration-options | |
| POST | /open-banking/enrollments/v2/enrollments/enrollmentId/fido-sign-options | |
| POST | /open-banking/enrollments/v2/enrollments/enrollmentId/risk-signals | |
| Pagamentos | POST | /open-banking/payments/v4/consents |
| GET | /open-banking/payments/v4/consents/consentId | |
| POST | /open-banking/payments/v4/pix/payments | |
| GET | /open-banking/payments/v4/pix/payments/paymentId | |
| PATCH | /open-banking/payments/v4/pix/payments/paymentId | |
| PATCH | /open-banking/payments/v4/pix/payments/consents/consentId |
Fase 4
| Produto | Método | Endpoint |
|---|---|---|
| Funds | GET | /open-banking/funds/v1/investments |
| GET | /open-banking/funds/v1/investments/investmentId | |
| GET | /open-banking/funds/v1/investments/investmentId/balances | |
| GET | /open-banking/funds/v1/investments/investmentId/transactions | |
| GET | /open-banking/funds/v1/investments/investmentId/transactions-current |
Outros
| Funcionalidade | Método | Endpoint |
|---|---|---|
| Security | POST | /register |
| GET | /register/clientId | |
| PUT | /register/clientId | |
| DELETE | /register/clientId | |
| POST | /token | |
| POST | /revocation | |
| POST | /pushed-authorization-request | |
| Webhook | POST | /open-banking/webhook/v1/automatic-payments/v1/pix/recurring-payments/recurringPaymentId |
| POST | /open-banking/webhook/v1/automatic-payments/v1/recurring-consents/recurringConsentId | |
| POST | /open-banking/webhook/v1/enrollments/v1/enrollments/enrollmentId | |
| POST | /open-banking/webhook/v1/payments/v3/consents/consentId | |
| POST | /open-banking/webhook/v1/payments/v3/pix/payments/paymentId | |
| POST | /open-banking/webhook/v1/payments/v4/consents/consentId | |
| POST | /open-banking/webhook/v1/payments/v4/pix/payments/paymentId |
Updated 8 months ago