Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Abaixo a lista dos endpoints aceitas pela PCM para cada categoria de API. Para maiores informações, veja as regras para utilização em Campos Especiais (itens endpoint e additionalInfo).

API Private Reports

...

/register

...

/register/{clientId}

...

/token

...

/revocation

...

/introspection

...

  • accounts
    /open-banking/accounts/v1/accounts
    /open-banking/accounts/v1/accounts/{accountId}
    /open-banking/accounts/v1/accounts/{accountId}/balances
    /open-banking/accounts/v1/accounts/{accountId}/overdraft-limits
    /open-banking/accounts/v1/accounts/{accountId}/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}/overdraft-limits
    /open-banking/accounts/v2/accounts/{accountId}/transactions
    /open-banking/accounts/v2/accounts/{accountId}/transactions-current

  • admin
    /open-banking/admin/v1/metrics
    /open-banking/admin/v2/metrics

  • automatic payments
    /open-banking/automatic-payments/v1/pix/recurring-payments
    /open-banking/automatic-payments/v1/pix/recurring-payments/{recurringPaymentId}
    /open-banking/automatic-payments/v1/pix/recurring-payments/{recurringPaymentId}
    /open-banking/automatic-payments/v1/recurring-consents
    /open-banking/automatic-payments/v1/recurring-consents/{recurringConsentId}
    /open-banking/automatic-payments/v1/recurring-consents/{recurringConsentId}

  • bank fixed incomes
    /open-banking/bank-fixed-incomes/v1/investments
    /open-banking/bank-fixed-incomes/v1/investments/{investmentId}
    /open-banking/bank-fixed-incomes/v1/investments/{investmentId}/balances
    /open-banking/bank-fixed-incomes/v1/investments/{investmentId}/transactions
    /open-banking/bank-fixed-incomes/v1/investments/{investmentId}/transactions-current

  • consents
    /open-banking/consents/v1/consents
    /open-banking/consents/

...

  • v1/consents/{consentId}
    /open-banking/consents/

...

  • v1/consents/{consentId}
    /open-banking/

...

  • consents/v2/

...

  • consents
    /open-banking/

...

  • consents/v2/

...

  • consents/

...

  • {consentId}
    /open-banking/

...

  • consents/v2/

...

  • consents/

...

  • {consentId}
    /open-banking/

...

  • consents/v2/

...

  • consents/{consentId}/extends
    /open-banking/

...

  • consents/v2

...

  • /consents/{consentId}/extends
    /open-banking/consents/v3/consents
    /open-banking/consents/v3/consents
    /open-banking/consents/

...

  • v3/

...

  • consents/{consentId}
    /open-banking/consents/v3/consents/{consentId}
    /open-banking/

...

  • consents/v3/consents/{consentId}/extends
    /open-banking/consents/v3/consents/{consentId}/extensions

  • credit cards accounts
    /open-banking/credit-cards-accounts/

...

  • v1/accounts
    /open-banking/credit-cards-accounts/

...

  • v1/accounts/{creditCardAccountId}
    /open-banking/credit-cards-accounts/

...

  • v1/accounts/{creditCardAccountId}/

...

  • bills
    /open-banking/credit-cards-accounts/

...

  • v1/accounts/{creditCardAccountId}/bills/{billId}/transactions
    /open-banking/credit-cards-accounts/

...

  • v1/accounts/{creditCardAccountId}/transactions

...


  • /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}/limits
    /open-banking/credit-cards-accounts/v2/accounts/{

...

  • creditCardAccountId}/

...

  • transactions
    /open-banking/credit-cards-accounts/v2/accounts/{

...

  • creditCardAccountId}/transactions-current

  • credit cards incomes
    /open-banking/credit-fixed-incomes/v1/investments
    /open-banking/credit-fixed-incomes/v1/investments/{investmentId}
    /open-banking/credit-fixed-incomes/v1/investments/{investmentId}/balances
    /open-banking/credit-fixed-incomes/v1/investments/{investmentId}/transactions
    /open-banking/

...

  • credit-fixed-incomes/v1/investments/{

...

  • investmentId}/transactions-current

  • costumers
    /open-banking/customers/v1/business/financial-relations
    /open-banking/customers/v1/business/identifications
    /open-banking/customers/v1/business/qualifications
    /open-banking/customers/v1/personal/financial-relations
    /open-banking/customers/v1/personal/identifications
    /open-banking/customers/v1/personal/qualifications
    /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

  • discovery
    /open-banking/discovery/v1/outages
    /open-banking/discovery/v1/status
    /open-banking/discovery/v2/outages
    /open-banking/discovery/v2/status

  • enrollments
    /open-banking/enrollments/v1/consents/{consentId}/authorise
    /open-banking/enrollments/v1/enrollments
    /open-banking/enrollments/v1/enrollments/{enrollmentId}
    /open-banking/enrollments/v1/enrollments/{enrollmentId}/fido-registration
    /open-banking/enrollments/v1/enrollments/{enrollmentId}/fido-registration-options
    /open-banking/enrollments/v1/enrollments/{enrollmentId}/fido-sign-options
    /open-banking/enrollments/v1/enrollments/{enrollmentId}/risk-signals
    /open-banking/enrollments/v2/consents/{consentId}/authorise
    /open-banking/enrollments/v2/enrollments
    /open-banking/enrollments/v2/enrollments/{enrollmentId}
    /open-banking/

...

  • enrollments/v2/

...

  • enrollments/{

...

  • enrollmentId}/

...

  • fido-

...

  • registration
    /open-banking/

...

  • enrollments/v2/

...

  • enrollments/{enrollmentId}/fido-registration-options
    /open-banking/

...

  • enrollments/v2/

...

  • enrollments/{

...

  • enrollmentId}/fido-sign-options
    /open-banking/

...

  • enrollments/v2/enrollments/{enrollmentId}/risk-signals

  • exchanges
    /open-banking/exchanges/v1/operations
    /open-banking/exchanges/v1/operations/{operationId}
    /open-banking/exchanges/v1/operations/{operationId}/events

  • financings
    /open-banking/financings/v1/contracts
    /open-banking/financings/v1/contracts/{contractId}

...


  • /open-banking/

...

  • financings/

...

  • v1/contracts/{contractId}/payments
    /open-banking/

...

  • financings/

...

  • v1/contracts/{contractId}/scheduled-instalments
    /open-banking/financings/v1/contracts/{contractId}/warranties
    /open-banking/financings/v2/contracts
    /open-banking/financings/v2/contracts/{contractId}
    /open-banking/financings/v2/contracts/{contractId}/

...

  • payments
    /open-banking/financings/v2/contracts/{contractId}/

...

  • scheduled-instalments
    /open-banking/financings/v2/contracts/{contractId}/warranties

  • funds
    /open-banking/funds/v1/investments
    /open-banking/funds/v1/investments/{investmentId}
    /open-banking/funds/v1/investments/{investmentId}/balances
    /

...

  • open-banking/funds/v1/investments/{investmentId}/transactions
    /open-banking

...

  • /funds/v1/investments/{investmentId}/transactions-current

  • invoice financings
    /open-banking/invoice-financings/v1/contracts
    /open-banking

...

  • /invoice-financings/v1/contracts/{contractId}
    /open-banking/invoice-financings/v1/contracts/{contractId}/payments
    /open-banking/

...

  • invoice-financings/v1/contracts/{contractId}/scheduled-instalments
    /open-banking/invoice-financings/v1/contracts/{contractId}/warranties
    /open-banking/invoice-financings/v2/contracts
    /open-banking

...

  • /invoice-financings/v2/contracts/{contractId}
    /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

  • loans
    /open-banking/loans/v1/contracts
    /open-banking

...

  • /loans/v1/contracts/{contractId}
    /open-banking/loans/v1/contracts/{contractId}/payments
    /open-banking

...

  • /loans/v1/contracts/{contractId}/scheduled-instalments
    /open-banking/loans/v1/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

  • payments
    /open-banking/payments/v1/consents
    /open-banking/payments/v1/consents/{consentId}
    /open-banking/payments/v1/pix/payments
    /open-banking/payments/v1/pix/payments/{paymentId}
    /open-banking/payments/v2/consents
    /open-banking/payments/v2/consents/{consentId}
    /open-banking/payments/v2/pix/payments
    /open-banking/payments/v2/pix/payments/{paymentId}
    /open-banking/payments/v2/pix/payments/{paymentId}
    /open-banking/payments/v3/consents
    /open-banking/payments/v3/consents/{consentId}
    /open-banking/payments/v3/pix/payments
    /open-banking/payments/v3/pix/payments/{paymentId}
    /open-banking/payments/v3/pix/payments/{paymentId}
    /open-banking/payments/v4/consents
    /open-banking/payments/v4/consents/{consentId}
    /open-banking/payments/v4/pix/payments
    /open-banking/payments/v4/pix/payments/{paymentId}
    /open-banking/payments/v4/pix/payments/{paymentId}
    /open-banking/payments/v4/pix/payments/consents/{consentId}

  • resources
    /open-banking/resources/v2/resources
    /open-banking/resources/v2/resources
    /open-banking/resources/v3/resources

  • security
    /register
    /register/{clientId}
    /token
    /revocation
    /introspection
    /pushed-authorization-request

  • treasure titles
    /open-banking/

...

  • treasure-titles/v1/

...

  • investments
    /open-banking/

...

  • treasure-titles/v1/

...

  • investments/{

...

  • investmentId}
    /open-banking/

...

  • treasure-titles/v1/

...

  • investments/{

...

  • investmentId}/balances
    /open-banking/treasure-titles/v1/investments/{investmentId}/transactions
    /open-banking/

...

  • treasure-titles/v1/

...

  • investments/{

...

  • investmentId}/transactions-current

  • unarranged accounts overdraft
    /open-banking/unarranged-accounts-overdraft/v1/contracts
    /open-banking/

...

  • unarranged-accounts-overdraft/v1/

...

  • contracts/{

...

  • contractId}

...


  • /open-banking/unarranged-accounts-overdraft/v1/contracts/{contractId}/payments
    /open-banking/

...

  • unarranged-accounts-overdraft/v1/

...

  • contracts/{

...

  • contractId}/

...

  • scheduled-

...

  • instalments
    /open-banking/

...

  • unarranged-accounts-overdraft/v1/

...

  • 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}/payments

...


  • /open-banking/unarranged-accounts-overdraft/v2/contracts/{contractId}/scheduled-instalments
    /open-banking/

...

  • unarranged-accounts-overdraft/v2/contracts/{

...

  • contractId}/warranties

  • variable incomes
    /open-banking/

...

  • variable-incomes/

...

  • v1/

...

  • broker-notes/{brokerNoteId}
    /open-banking

...

  • /variable-incomes/v1/investments
    /open-banking/variable-incomes/v1/investments/{investmentId}
    /open-banking

...

  • /variable-incomes/v1/investments/{investmentId}/balances
    /open-banking/variable-incomes/v1/investments/{investmentId}/transactions
    /open-banking/

...

  • variable-incomes/v1

...

  • /investments/{investmentId}/transactions-current

  • webhook
    /open-banking/webhook/v1/automatic-payments/v1/pix/recurring-payments/{recurringPaymentId}
    /open-banking/webhook/v1/automatic-payments/v1/recurring-consents/{recurringConsentId}
    /open-banking/webhook/v1/enrollments/v1/enrollments/{enrollmentId}
    /open-banking/webhook/v1/payments/v3/consents/{consentId}
    /open-banking/

...

  • webhook/v1/payments/v3/pix/payments/{paymentId}
    /open-banking/webhook/v1/payments/v4/consents/{consentId}
    /open-banking/webhook/v1/payments/v4/pix/payments/{paymentId}

API Open Data

  • channels
    /open-banking/channels/v1/banking-agents
    /open-banking

...

  • /channels/v1/branches
    /open-banking/channels/v1/

...

  • electronic-

...

  • channels
    /open-banking

...

  • /channels/v1/phone-channels
    /open-banking/channels/v1/shared-automated-teller-machines
    /open-banking/channels/v2/banking-agents
    /open-banking

...

  • /channels/v2/branches
    /open-banking/channels/v2/electronic-channels
    /open-banking

...

  • /channels/v2/phone-channels
    /open-banking/channels/v2/shared-automated-teller-machines

  • accounts
    /open-banking/

...

  • opendata-

...

  • accounts/v1/personal-

...

  • accounts

  • acquiring services
    /open-banking/

...

  • opendata-acquiring-services/v1/

...

  • businesses
    /open-banking/opendata-acquiring-services/v1/personals

  • capitalization
    /open-banking/

...

  • opendata-

...

  • capitalization/v1/bonds
    /

...

  • open-

...

  • banking/opendata-capitalization/v2/bonds

  • creditcards
    /open-banking/

...

  • opendata-

...

  • creditcards/v1/business-

...

  • credit-

...

  • cards
    /open-banking/

...

  • opendata-

...

  • creditcards/v1/personal-credit-cards

  • exchange
    /open-banking/

...

  • opendata-

...

  • exchange/v1/

...

  • online-

...

  • rates
    /open-banking/

...

  • opendata-

...

  • exchange/v1/vet-rates
    /

...

  • open-

...

  • banking/opendata-exchange/v1/vet-values

  • financings
    /open-banking/

...

  • opendata-

...

  • financings/v1/business

...

  • -financings
    /open-banking/opendata-financings/v1/personal-financings

  • insurance
    /open-banking/

...

  • opendata-insurance/v1

...

  • /personals
    /open-banking/opendata-insurance/v2/personals

  • investments
    /open-banking/

...

  • opendata-investments/v1/

...

  • bank-fixed-

...

  • incomes
    /open-banking/

...

  • opendata-investments/v1/

...

  • credit-fixed-

...

  • incomes
    /open-banking/

...

  • opendata-investments/v1/funds
    /open-banking

...

  • /opendata-investments/v1/treasure-titles
    /open-banking/

...

  • opendata-investments/v1

...

open-banking/channels/v2/banking-agents

...

open-banking/channels/v2/branches

...

open-banking/channels/v2/eletronic-channels

...

open-banking/channels/v2/phone-channels

...

open-banking/channels/v2/shared-automated-teller-machines

...

GET open-banking/discovery/v2/outages

...

open-banking/discovery/v2/status

  • /variable-incomes

  • invoice financings
    /open-banking/opendata-invoicefinancings/v1/business-invoice-financings
    /open-banking/opendata-invoicefinancings/v1/personal-invoice-financings

  • loans
    /open-banking/opendata-loans/v1/business-loans
    /open-banking/opendata-loans/v1/personal-loans

  • pension
    /open-banking/opendata-pension/v1/risk-coverages
    /open-banking/opendata-pension/v1/survival-coverages
    /open-banking/opendata-pension/v2/risk-coverages
    /open-banking/opendata-pension/v2/survival-coverages

  • unarranged
    /open-banking/opendata-unarranged/v1/business-unarranged-account-overdraft
    /open-banking/opendata-

...

  • unarranged/v1/personal-

...

  • unarranged-account-overdraft

  • products services
    /open-banking/opendata-accounts/v1/business-accounts
    /open-banking/opendata-creditcards/v1/

...

  • business-credit-cards
    /open-banking/opendata-creditcards/v1/

...

  • personal-credit-cards
    /open-banking/opendata-financings/v1/business-financings
    /open-banking/opendata-

...

  • financings/v1/personal-

...

  • financings
    /open-banking/opendata-

...

  • loans/v1/business

...

  • -loans
    /open-banking/opendata-loans/v1/personal-loans
    /open-banking/opendata-unarranged/v1/

...

  • business-unarranged-account-overdraft
    /open-banking/opendata-unarranged/v1/personal-unarranged-account-overdraft
    /open-banking/products-services/v1/business-accounts
    /open-banking/products-services/v1/business-credit-cards
    /open-banking/products-services/v1/business-financings
    /open-banking/products-services/v1/business-invoice-financings
    /open-banking/products-services/v1/business-loans
    /open-banking/products-services/v1/business-unarranged-account-overdraft
    /open-banking/

...

  • products-

...

  • services/v1/personal-

...

  • accounts
    /open-banking/

...

  • products-

...

  • services/v1/

...

  • personal-credit-

...

  • cards
    /open-banking/

...

  • products-services/v1/personal-financings
    /open-banking/products-services/v1/personal-invoice-financings
    /open-banking/

...

  • products-services/v1/personal-loans
    /open-banking/products-services/v1/

...

  • personal-unarranged-account-overdraft