Criar um Token de Acesso

Cria um novo token de acesso (access token) para autenticação na API. O token criado pode ter escopos limitados e data de expiração.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Informações do token de acesso a ser criado.

string

ID externo do token

string
length ≤ 100

Descrição do token

string
enum

Tipo de escopo: Todos (all) ou Limitado (limited)

Allowed:
limited_scopes
array of strings

Escopos disponíveis (quando scope_type = limited). Selecione um ou mais valores:

EscopoDescrição
admin.subaccountsGerenciar subcontas da conta principal
admin.usersGerenciar usuários e permissões
automation.email_accountsGerenciar contas de e-mail para automação
automation.email_deliveriesVisualizar e gerenciar envios de e-mail
automation.sms_accountsGerenciar contas de SMS
automation.sms_deliveriesVisualizar e gerenciar envios de SMS
automation.webhook_deliveriesVisualizar e gerenciar entregas de webhooks
automation.webhooksGerenciar webhooks e notificações automatizadas
billing.transactionsVisualizar transações de cobrança e faturamento
charge.automatic_pix.locationsGerenciar localizações de Pix automático
charge.automatic_pix.pixGerenciar cobranças Pix automáticas
charge.automatic_pix.recurrencesGerenciar recorrências de Pix automático
charge.automatic_pix.requestsGerenciar solicitações de Pix automático
charge.bank_billet_accountsGerenciar contas de boletos bancários
charge.bank_billet_paymentsVisualizar e registrar pagamentos de boletos
charge.bank_billet_registrationsGerenciar registros de boletos nos bancos
charge.bank_billetsGerenciar boletos bancários
charge.customer_subscriptionsGerenciar assinaturas de clientes
charge.installmentsGerenciar parcelamentos
charge.paymentsVisualizar e gerenciar pagamentos recebidos
charge.pixGerenciar cobranças Pix
charge.pix_accountsGerenciar contas Pix
core.providersVisualizar provedores disponíveis
crm.customersGerenciar clientes e informações comerciais
crm.peopleGerenciar pessoas e contatos
data.bank_billet_queriesConsultar informações de boletos bancários
financial.accountsGerenciar contas financeiras
financial.balancesVisualizar saldos e movimentações financeiras
financial.providersGerenciar provedores financeiros e integrações bancárias
financial.statement_transactionsVisualizar transações e extratos financeiros
integration.certificatesGerenciar certificados digitais para integrações
integration.connectionsGerenciar conexões com bancos e provedores
integration.dischargesGerenciar arquivos de retorno bancário (baixas)
integration.edi_boxesGerenciar caixas postais EDI para troca de arquivos
integration.remittancesGerenciar arquivos de remessa bancária
mailbox.entriesGerenciar caixas postais para recebimento de arquivos
mailbox.filesVisualizar e gerenciar arquivos nas caixas postais
partner.bank_contractsGerenciar contratos bancários com parceiros
payment.accountsGerenciar contas de pagamento (incluindo habilitação de remessa EDI)
payment.bank_billetsEfetuar pagamentos de boletos bancários
payment.batchesGerenciar lotes de pagamentos
payment.dda_accountsGerenciar contas DDA
payment.dda.bank_billetsGerenciar boletos DDA
payment.darfsEfetuar pagamentos de DARFs (tributos federais)
payment.paymentsGerenciar todos os tipos de pagamentos através da API
payment.pixEfetuar pagamentos via Pix
payment.taxesEfetuar pagamentos de impostos e taxas
payment.utilitiesEfetuar pagamentos de contas de consumo (água, luz, etc)
security.access_tokensGerenciar tokens de acesso e autenticação
system.eventsVisualizar eventos e logs do sistema
system.importsGerenciar importações de dados
system.reportsGerar e visualizar relatórios do sistema
transfer.accountsGerenciar contas de transferência (incluindo habilitação de remessa EDI)
transfer.batchesGerenciar lotes de transferências
transfer.internalRealizar transferências internas entre contas
transfer.pixRealizar transferências via Pix
transfer.tedRealizar transferências TED
transfer.transfersGerenciar todos os tipos de transferências (Pix, TED, Internas) via endpoint unificado
limited_scopes
string
enum

Tipo de acesso: Leitura (read) ou Leitura e escrita (write)

Allowed:
date

Data de expiração (máximo 1 ano). Obrigatório quando access_type = write

tags
array of strings

Tags do token

tags
custom_data
object

Dados customizados

reminder_emails
array of objects

E-mails para notificações de expiração. Obrigatório quando expires_at é definido.

reminder_emails
Headers
string

Informar um e-mail válido para contatos.

string

Chave de idempotência para evitar replay de processamento.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json