Efí Pay (Gerencianet) · OAuth Scopes
Efí Pay (Gerencianet) OAuth Scopes
OAuth 2.0
searched
Efí Pay (Gerencianet) publishes 40 OAuth 2.0 scopes via the clientCredentials flow. Scopes are the fine-grained permissions an application requests at authorization time to act against the Efí Pay (Gerencianet) API on a user’s behalf.
Tokens are issued from https://pix.api.efipay.com.br/oauth/token.
This index is generated from the provider’s OpenAPI security definitions (and, where available, its documented scope reference) and refreshes on every APIs.io network build. Browse every provider’s scopes at scopes.apis.io.
PaymentsPixBoletoSubscriptionRecurring BillingMarketplaceSplit PaymentsOpen FinanceBanking as a ServiceAccount OpeningBill PaymentsCNABBrazilFintech
Scopes: 40
Flows: clientCredentials
Method: searched
OAuth endpoints
Token URL
https://pix.api.efipay.com.br/oauth/token https://abrircontas.api.efipay.com.br/v1/oauth/token https://cobrancas.api.efipay.com.br/v1/authorize https://extratos.api.efipay.com.br/v1/oauth/token https://openfinance.api.efipay.com.br/v1/oauth/token https://pagarcontas.api.efipay.com.br/v1/oauth/token
https://pix.api.efipay.com.br/oauth/token https://abrircontas.api.efipay.com.br/v1/oauth/token https://cobrancas.api.efipay.com.br/v1/authorize https://extratos.api.efipay.com.br/v1/oauth/token https://openfinance.api.efipay.com.br/v1/oauth/token https://pagarcontas.api.efipay.com.br/v1/oauth/token
Flows
clientCredentials
clientCredentials
Scopes (40)
| Scope | Description | Flows |
|---|---|---|
| cob.read | Read immediate charges | clientCredentials |
| cob.write | Create/update immediate charges | clientCredentials |
| cobv.read | Read due charges | clientCredentials |
| cobv.write | Create/update due charges | clientCredentials |
| gn.balance.read | Read account balance | clientCredentials |
| openfinance.payments.read | Read payment status | clientCredentials |
| openfinance.payments.write | Initiate payments | clientCredentials |
| pix.read | Read received Pix | clientCredentials |
| pix.send | Send Pix | clientCredentials |
| pix.write | Manage devolutions | clientCredentials |
| webhook.read | Read webhook config | clientCredentials |
| webhook.write | Configure webhooks | clientCredentials |
| gn.pix.send.read | Consultar pix enviado | clientCredentials |
| payloadlocation.write | Alterar Payloads | clientCredentials |
| payloadlocation.read | Consultar Payloads | clientCredentials |
| gn.pix.evp.write | Alterar Chaves aleatórias | clientCredentials |
| gn.pix.evp.read | Consultar Chaves aleatórias | clientCredentials |
| gn.settings.write | Alterar Configurações da API | clientCredentials |
| gn.settings.read | Consultar Configurações da API | clientCredentials |
| gn.reports.write | Solicitar relatórios | clientCredentials |
| gn.reports.read | Consultar relatórios | clientCredentials |
| gn.split.read | Consultar configuração de venda (split pix) | clientCredentials |
| gn.split.write | Criar configuração de venda (split pix) | clientCredentials |
| lotecobv.read | Alterar lote de cobranças com vencimento | clientCredentials |
| lotecobv.write | Consultar lote de cobranças com vencimento | clientCredentials |
| gn.infractions.write | Submeter defesa de infração MED | clientCredentials |
| gn.infractions.read | Listar as infrações MED da conta | clientCredentials |
| gn.receipts.read | Baixar comprovante Pix | clientCredentials |
| rec.read | Consultar recorrências de Pix Automático | clientCredentials |
| rec.write | Alterar recorrências de Pix Automático | clientCredentials |
| solicrec.read | Consultar solicitações de Pix Automático | clientCredentials |
| solicrec.write | Alterar solicitações de Pix Automático | clientCredentials |
| cobr.read | Consultar cobranças de Pix Automático | clientCredentials |
| cobr.write | Alterar cobranças de Pix Automático | clientCredentials |
| payloadlocationrec.read | Consultar payloads de Pix Automático | clientCredentials |
| payloadlocationrec.write | Alterar payloads de Pix Automático | clientCredentials |
| webhookrec.read | Consultar webhook recorrências de Pix Automático | clientCredentials |
| webhookrec.write | Alterar webhook de recorrências de Pix Automático | clientCredentials |
| webhookcobr.read | Consultar webhook de cobranças de Pix Automático | clientCredentials |
| webhookcobr.write | Alterar webhook de cobranças de Pix Automático | clientCredentials |
📄 Provider scope reference: https://dev.efipay.com.br/docs/api-pix/credenciais
Source
OAuth Scopes
Work with this as data
Every scope set here is available over the APIs.io API and to AI agents over MCP.