Efí Pay (Gerencianet) OAuth Scopes

OAuth 2.0 derived

Efí Pay (Gerencianet) publishes 12 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://cobrancas.api.efipay.com.br/v1/authorize.

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.

PaymentsPixBoletoSubscriptionsRecurring BillingMarketplaceSplit PaymentsOpen FinanceBanking as a ServiceAccount OpeningBill PaymentCNABBrazilFintech

Scopes: 12 Flows: clientCredentials Method: derived

OAuth endpoints

Token URL
https://cobrancas.api.efipay.com.br/v1/authorize https://abrircontas.api.efipay.com.br/v1/oauth/token 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

Flows
clientCredentials

Scopes (12)

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

📄 Provider scope reference:

Source

OAuth Scopes

generated: '2026-07-11'
method: derived
source: openapi/efi-cobrancas-openapi.yml, openapi/efi-contas-openapi.yml, openapi/efi-extratos-openapi.yml,
  openapi/efi-openfinance-openapi.yml, openapi/efi-pagamentos-openapi.yml, openapi/efi-pix-openapi.yml
schemes:
- name: oauth2ClientCredentials
  source: openapi/efi-cobrancas-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: https://cobrancas.api.efipay.com.br/v1/authorize
- name: oauth2Contas
  source: openapi/efi-contas-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: https://abrircontas.api.efipay.com.br/v1/oauth/token
- name: oauth2Extratos
  source: openapi/efi-extratos-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: https://extratos.api.efipay.com.br/v1/oauth/token
- name: oauth2OpenFinance
  source: openapi/efi-openfinance-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: https://openfinance.api.efipay.com.br/v1/oauth/token
- name: oauth2Pagamentos
  source: openapi/efi-pagamentos-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: https://pagarcontas.api.efipay.com.br/v1/oauth/token
- name: oauth2Pix
  source: openapi/efi-pix-openapi.yml
  flows:
  - flow: clientCredentials
    tokenUrl: https://pix.api.efipay.com.br/oauth/token
scopes:
- scope: cob.read
  description: Read immediate charges
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: cob.write
  description: Create/update immediate charges
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: cobv.read
  description: Read due charges
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: cobv.write
  description: Create/update due charges
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: gn.balance.read
  description: Read account balance
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: openfinance.payments.read
  description: Read payment status
  flows:
  - clientCredentials
  sources:
  - openapi/efi-openfinance-openapi.yml
- scope: openfinance.payments.write
  description: Initiate payments
  flows:
  - clientCredentials
  sources:
  - openapi/efi-openfinance-openapi.yml
- scope: pix.read
  description: Read received Pix
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: pix.send
  description: Send Pix
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: pix.write
  description: Manage devolutions
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: webhook.read
  description: Read webhook config
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml
- scope: webhook.write
  description: Configure webhooks
  flows:
  - clientCredentials
  sources:
  - openapi/efi-pix-openapi.yml