Obter token de acesso.
POST
/oauth/token
Autenticação
Authorization. Após obter o token, sua aplicação pode acessar os endpoints compatíveis com os escopos concedidos.Escopos
.read — consultar..create — criar..write — criar com permissão completa de execução.| Escopo | Para que serve |
|---|---|
| Conta e extrato | |
| account.read | Permite consultar saldo e extratos da conta. |
| transactions.read | Permite consultar transações da conta. |
| Pix | |
| pix.read | Permite consultar chaves Pix, dados de QR Code, estatísticas e status de pagamentos Pix. |
| pix.create | Permite criar pagamentos Pix. |
| pix.write | Permite criar pagamentos Pix e gerenciar chaves Pix da conta. |
| Transferência interna | |
| internal-transfer.read | Permite consultar transferências internas. |
| internal-transfer.create | Permite criar transferências internas. |
| internal-transfer.write | Permite criar transferências internas com permissão completa de execução. |
| TED | |
| ted.read | Permite consultar TEDs. |
| ted.create | Permite criar TEDs. |
| ted.write | Permite criar TEDs com permissão completa de execução. |
| Boletos | |
| billets.read | Permite consultar boletos e informações para pagamento. |
| billets.create | Permite criar solicitações de pagamento de boleto. |
| billets.write | Permite pagar boletos. |
| Webhooks | |
| webhook.read | Permite consultar os webhooks cadastrados. |
| webhook.write | Permite cadastrar, alterar ou remover webhooks. |
| Infrações | |
| infractions.read | Permite consultar infrações Pix. |
| infractions.write | Permite responder ou enviar defesa de infrações Pix. |
| BaaS | |
| baas.accounts.read | Permite consultar contas vinculadas ao BaaS. |
| baas.onboarding.read | Permite consultar cadastros/onboardings. |
| baas.onboarding.write | Permite criar cadastros/onboardings e enviar documentos. |
| baas.credentials.write | Permite criar credenciais de API para contas vinculadas. |
| eConsignado | |
| econsignado.read | Permite consultar dados, propostas, autorizações e contratos do eConsignado. |
| econsignado.write | Permite enviar propostas, autorizações e operações do eConsignado. |
| Cripto | |
| crypto-risk.read | Permite consultar análises de risco de carteiras cripto. |
| crypto-risk.write | Permite criar análises de risco de carteiras cripto. |
| crypto-caas.read | Permite consultar carteiras, cotações e ordens cripto. |
| crypto-caas.write | Permite criar carteiras, cotações e ordens cripto. |
| Crédito e cobranças | |
| invoices.read | Permite consultar cobranças/faturas. |
| invoices.write | Permite criar, alterar ou cancelar cobranças/faturas. |
| credit.products.read | Permite consultar produtos de crédito disponíveis. |
| credit.simulations.write | Permite criar simulações de crédito. |
| credit.applications.write | Permite criar propostas de crédito. |
| credit.bankarization.applications.read | Permite consultar solicitações de bancarização. |
| credit.bankarization.applications.write | Permite criar ou atualizar solicitações de bancarização. |
| credit.consignado.read | Permite consultar produtos, propostas e contratos de crédito consignado. |
| credit.consignado.write | Permite criar propostas e operações de crédito consignado. |
| credit.loans.read | Permite consultar operações de crédito. |
Requisição
Parâmetros BodyNecessário
application/json
Respostas
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '/oauth/token' \
--header 'Content-Type: application/json' \
--data '{
"clientId": "string",
"clientSecret": "string",
"grantType": "client_credentials",
"scope": "string"
}'Response Response Example
201 - Exemplo 1
{
"tokenType": "string",
"expiresAt": 0,
"refreshExpiresIn": 0,
"notBeforePolicy": 0,
"accessToken": "string",
"scope": "string"
}