Efí Pay (Gerencianet)

Efí Pay (Gerencianet) Scheduled Pix API

The Scheduled Pix API from Efí Pay (Gerencianet) — 3 operation(s) for scheduled pix.

GitHub OpenAPI

Documentation

📖
Documentation
https://dev.efipay.com.br/docs/api-cobrancas/credenciais
📖
APIReference
https://dev.efipay.com.br
📖
Documentation
https://dev.efipay.com.br/docs/api-pix/credenciais
📖
APIReference
https://dev.efipay.com.br/docs/api-pix
📖
Documentation
https://dev.efipay.com.br/docs/open-finance
📖
Documentation
https://dev.efipay.com.br/docs/abertura-de-contas
📖
Documentation
https://dev.efipay.com.br/docs/api-pagamentos
📖
Documentation
https://dev.efipay.com.br/docs/extrato-cnab

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/openapi/gerencianet-scheduled-pix-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-cobrancas-charge-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-cobrancas-charge-structure.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-cob-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-pix-received-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-pix-cob-structure.json

Other Resources

🔗
BaseURL
https://cobrancas.api.efipay.com.br/v1
🔗
SandboxURL
https://cobrancas-h.api.efipay.com.br/v1
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-cobrancas-onestep-example.json
🔗
BaseURL
https://pix.api.efipay.com.br
🔗
SandboxURL
https://pix-h.api.efipay.com.br
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-create-cob-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-send-example.json
🔗
BaseURL
https://openfinance.api.efipay.com.br/v1
🔗
SandboxURL
https://openfinance-h.api.efipay.com.br/v1
🔗
BaseURL
https://abrircontas.api.efipay.com.br/v1
🔗
SandboxURL
https://abrircontas-h.api.efipay.com.br/v1
🔗
BaseURL
https://pagarcontas.api.efipay.com.br/v1
🔗
SandboxURL
https://pagarcontas-h.api.efipay.com.br/v1
🔗
BaseURL
https://extratos.api.efipay.com.br/v1
🔗
SandboxURL
https://extratos-h.api.efipay.com.br/v1

OpenAPI Specification

gerencianet-scheduled-pix-api-openapi.yml Raw ↑ 
openapi: 3.0.3
info:
  title: Efí Pay Cobranças Account Scheduled Pix API
  description: Billing API for Efí Pay (formerly Gerencianet). Issue boletos (Brazilian bank slips), Bolix (next-business-day boletos), carnês (installment booklets), payment links, credit card charges, subscriptions/recurring billing, and marketplace payment splits. OAuth2 with HTTP Basic for client_credentials.
  version: '1.0'
  contact:
    name: Efí Pay Developer Support
    url: https://dev.efipay.com.br
  license:
    name: Proprietary
servers:
- url: https://cobrancas.api.efipay.com.br/v1
  description: Production
- url: https://cobrancas-h.api.efipay.com.br/v1
  description: Homologation (Sandbox)
security:
- oauth2ClientCredentials: []
tags:
- name: Scheduled Pix
paths:
  /pagamentos-agendados/pix:
    post:
      tags:
      - Scheduled Pix
      summary: Start Scheduled Pix
      operationId: ofStartSchedulePixPayment
      responses:
        '201':
          description: Scheduled
    get:
      tags:
      - Scheduled Pix
      summary: List Scheduled Pix
      operationId: ofListSchedulePixPayment
      responses:
        '200':
          description: Scheduled list
  /pagamentos-agendados/pix/{identificadorPagamento}/cancelar:
    patch:
      tags:
      - Scheduled Pix
      summary: Cancel Scheduled Pix
      operationId: ofCancelSchedulePix
      parameters:
      - name: identificadorPagamento
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Cancelled
  /pagamentos-agendados/pix/{identificadorPagamento}/devolver:
    post:
      tags:
      - Scheduled Pix
      summary: Refund Scheduled Pix
      operationId: ofDevolutionSchedulePix
      parameters:
      - name: identificadorPagamento
        in: path
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Refunded
components:
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://cobrancas.api.efipay.com.br/v1/authorize
          scopes: {}