Referência
- 1 Relatórios e Métricas
- 1.1 API Admin
- 1.2 API Comum (Discovery)
- 2 Dados Abertos
- 3 Dados do Cliente
- 3.1 [DC] API Consentimento
- 3.2 [DC] API Recursos
- 3.3 [DC] API Dados Cadastrais
- 3.4 [DC] API Cartão de Crédito
- 3.5 [DC] API Contas
- 3.6 [DC] API Operações de Crédito - Empréstimo
- 3.7 [DC] API Operações de Crédito - Financiamento
- 3.8 [DC] API Operações de Crédito - Adiantamento a Depositantes
- 3.9 [DC] API Operações de Crédito - Direitos Creditórios Descontados
- 3.10 [DC] API Investimentos - Renda Fixa Bancária
- 3.11 [DC] API Investimentos - Renda Fixa Crédito
- 3.12 [DC] API Investimentos - Renda Variável
- 3.13 [DC] API Investimentos - Títulos do Tesouro Direto
- 3.14 [DC] API Investimentos - Fundos de Investimento
- 3.15 [DC] API Câmbio
- 4 Serviços
- 5 Webhook
Relatórios e Métricas
Endpoint | Frequência
| SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /metrics | Alta | 1500 | 15 | NA | NA | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /status | Alta | 1500 | 15 | NA | NA | NA |
GET /outages | Alta | 1500 | 15 | NA | NA | NA |
Dados Abertos
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /personal-accounts | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /business-accounts | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /personal-loans | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /business-loans | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /personal-credit-cards | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /business-credit-cards | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /personal-financings | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /business-financings | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /personal-invoice-financings | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /business-invoice-financings | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /personal-unarranged-account-overdraft | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /business-unarranged-account-overdraft | Baixa | 4000 | 15 | 500 | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /banking-agents | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /branches | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /electronic-channels | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /phone-channels | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /shared-automated-teller-machines | Baixa | 4000 | 15 | 500 | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /bonds | Baixa | 4000 | 15 | 500 | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /funds | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /bank-fixed-incomes | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /credit-fixed-incomes | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /variable-incomes | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /treasure-titles | Baixa | 4000 | 15 | 500 | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /online-rates | Alta | 1500 | 15 | 500 | 300 | NA |
GET /vet-values | Baixa | 4000 | 15 | 500 | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /businesses | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /personals | Baixa | 4000 | 15 | 500 | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /risk-coverages | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /survival-coverages | Baixa | 4000 | 15 | 500 | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /automotives | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /homes | Baixa | 4000 | 15 | 500 | 300 | NA |
GET /personals | Baixa | 4000 | 15 | 500 | 300 | NA |
Dados do Cliente
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
POST /consents | Alta | 1500 | 15 | NA | 300 | NA |
GET /consents/{consentId} | Alta | 1500 | 15 | NA | 300 | NA |
DELETE /consents/{consentId} | Alta | 1500 | 15 | NA | 300 | NA |
POST /consents/{consentId}/extends | Baixa | 4000 | 15 | NA | 300 | NA |
GET /consents/{consentId}/extensions | Baixa | 4000 | 15 | NA | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /resources | Alta | 1500 | 15 | NA | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /personal/identifications | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /personal/qualifications | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /personal/financial-relations | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /business/identifications | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /business/qualifications | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /business/financial-relations | Baixa | 4000 | 15 | 500 | 300 | 4 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /accounts | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /accounts/{creditCardAccountId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /accounts/{creditCardAccountId}/bills | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /accounts/{creditCardAccountId}/bills/{billId}/transactions | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /accounts/{creditCardAccountId}/limits | Alta | 1500 | 15 | 2000 | 300 | 240 |
GET /accounts/{creditCardAccountId}/transactions | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /accounts/{creditCardAccountId}/transactions-current | Alta | 1500 | 15 | 2000 | 300 | 240 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /accounts | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /accounts/{accountId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /accounts/{accountId}/balances | Alta | 1500 | 15 | 2000 | 300 | 420 |
GET /accounts/{accountId}/transactions | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /accounts/{accountId}/transactions-current | Alta | 1500 | 15 | 2000 | 300 | 240 |
GET /accounts/{accountId}/overdraft-limits | Alta | 1500 | 15 | 2000 | 300 | 420 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /contracts | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /contracts/{contractId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /contracts/{contractId}/warranties | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /contracts/{contractId}/scheduled-instalments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /contracts/{contractId}/payments | Média | 2000 | 15 | 1000 | 300 | 30 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /contracts | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /contracts/{contractId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /contracts/{contractId}/warranties | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /contracts/{contractId}/scheduled-instalments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /contracts/{contractId}/payments | Média | 2000 | 15 | 1000 | 300 | 30 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /contracts | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /contracts/{contractId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /contracts/{contractId}/warranties | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /contracts/{contractId}/scheduled-instalments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /contracts/{contractId}/payments | Média | 2000 | 15 | 1000 | 300 | 30 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /contracts | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /contracts/{contractId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /contracts/{contractId}/warranties | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /contracts/{contractId}/scheduled-instalments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /contracts/{contractId}/payments | Média | 2000 | 15 | 1000 | 300 | 30 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /investments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /investments/{investimentId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/balances | Média-alta | 1500 | 15 | 1500 | 300 | 120 |
GET /investments/{investimentId}/transactions | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/transactions-current | Média-alta | 1500 | 15 | 1500 | 300 | 120 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /investments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /investments/{investimentId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/balances | Média-alta | 1500 | 15 | 1500 | 300 | 120 |
GET /investments/{investimentId}/transactions | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/transactions-current | Média-alta | 1500 | 15 | 1500 | 300 | 120 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /investments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /investments/{investimentId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/balances | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /investments/{investimentId}/transactions | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/transactions-current | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /broker-notes/{brokerNoteId} | Média | 2000 | 15 | 1000 | 300 | 30 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /investments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /investments/{investimentId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/balances | Média-alta | 1500 | 15 | 1500 | 300 | 120 |
GET /investments/{investimentId}/transactions | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/transactions-current | Média-alta | 1500 | 15 | 1500 | 300 | 120 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /investments | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /investments/{investimentId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/balances | Média-alta | 1500 | 15 | 1500 | 300 | 120 |
GET /investments/{investimentId}/transactions | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /investments/{investimentId}/transactions-current | Média-alta | 1500 | 15 | 1500 | 300 | 120 |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
GET /operations | Média | 2000 | 15 | 1000 | 300 | 30 |
GET /operations/{operationId} | Baixa | 4000 | 15 | 500 | 300 | 4 |
GET /operations/{operationId}/events | Média | 2000 | 15 | 1000 | 300 | 30 |
Serviços
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
POST /consents | Alta | 1500 | 15 | NA | 300 | NA |
GET /consents/{consentId} | Alta | 1500 | 15 | NA | 300 | NA |
POST /pix/payments | Alta | 1500 | 15 | NA | 300 | NA |
GET /pix/payments/{paymentId} | Alta | 1500 | 15 | NA | 300 | NA |
PATCH /pix/payments/{paymentld} | Alta | 1500 | 15 | NA | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
POST /recurring-consents | Alta | 1500 | 15 | NA | 300 | NA |
GET /recurring-consents/{recurringConsentId} | Alta | 1500 | 15 | NA | 300 | NA |
PATCH /recurring-consents/{recurringConsentId} | Alta | 1500 | 15 | NA | 300 | NA |
POST /recurring-payments | Alta | 1500 | 15 | NA | 300 | NA |
GET /recurring-payments/{recurringPaymentId} | Alta | 1500 | 15 | NA | 300 | NA |
GET /recurring-payments | Alta | 1500 | 15 | NA | 300 | NA |
PATCH /recurring-payments/{recurringPaymentId} | Alta | 1500 | 15 | NA | 300 | NA |
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
POST /enrollments | Alta | 1500 | 15 | N/A | 300 | N/A |
GET /enrollments/{enrollmentId} | Alta | 1500 | 15 | N/A | 300 | N/A |
PATCH /enrollments/{enrollmentId} | Alta | 1500 | 15 | N/A | 300 | N/A |
POST /enrollments/{enrollmentId}/fido-registration-options | Alta | 1500 | 15 | N/A | 300 | N/A |
POST /enrollments/{enrollmentId}/fido-registration | Alta | 1500 | 15 | N/A | 300 | N/A |
POST /enrollments/{enrollmentId}/fido-sign-options | Alta | 1500 | 15 | N/A | 300 | N/A |
POST /enrollments/{enrollmentId}/risk-signals | Alta | 1500 | 15 | N/A | 300 | N/A |
Webhook
Endpoint | Frequência | SLA (ms)* | Timeout (s) | TPM | TPS | Limite Operacional (consultas/mês) |
POST /payments/[Versão da API]/consents/{consentId} | Alta | 1500 | 15 | NA | 300 | NA |
POST /payments/[Versão da API]/pix/payments/{paymentId} | Alta | 1500 | 15 | NA | 300 | NA |
Legenda
NA - Não se aplica
- Percentil 95