Efí Pay (Gerencianet)

Efí Pay (Gerencianet) Card Payments API

The Card Payments API from Efí Pay (Gerencianet) — 3 operation(s) for card payments.

Documentation GitHub OpenAPI

Documentation

https://dev.efipay.com.br/docs/api-cobrancas/credenciais

https://dev.efipay.com.br

https://dev.efipay.com.br/docs/api-pix/credenciais

https://dev.efipay.com.br/docs/api-pix

https://dev.efipay.com.br/docs/open-finance

https://dev.efipay.com.br/docs/abertura-de-contas

https://dev.efipay.com.br/docs/api-pagamentos

https://dev.efipay.com.br/docs/extrato-cnab

Specifications

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/openapi/gerencianet-card-payments-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-cobrancas-charge-schema.json

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-cobrancas-charge-structure.json

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-cob-schema.json

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-schema/efi-pix-pix-received-schema.json

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/json-structure/efi-pix-cob-structure.json

Other Resources

https://cobrancas.api.efipay.com.br/v1

https://cobrancas-h.api.efipay.com.br/v1

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-cobrancas-onestep-example.json

https://pix.api.efipay.com.br

https://pix-h.api.efipay.com.br

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-create-cob-example.json

https://raw.githubusercontent.com/api-evangelist/gerencianet/refs/heads/main/examples/efi-pix-send-example.json

https://openfinance.api.efipay.com.br/v1

https://openfinance-h.api.efipay.com.br/v1

https://abrircontas.api.efipay.com.br/v1

https://abrircontas-h.api.efipay.com.br/v1

https://pagarcontas.api.efipay.com.br/v1

https://pagarcontas-h.api.efipay.com.br/v1

https://extratos.api.efipay.com.br/v1

https://extratos-h.api.efipay.com.br/v1

OpenAPI Specification

openapi: 3.0.3
info:
  title: Efí Pay Cobranças Account Card Payments 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: Card Payments
paths:
  /charge/{id}/retry:
    post:
      tags:
      - Card Payments
      summary: Retry Card Payment
      operationId: cardPaymentRetry
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Retried
  /charge/card/{id}/refund:
    post:
      tags:
      - Card Payments
      summary: Refund Card Charge
      operationId: refundCard
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Refund issued
  /installments:
    get:
      tags:
      - Card Payments
      summary: Get Installments
      operationId: getInstallments
      responses:
        '200':
          description: Installments
components:
  securitySchemes:
    oauth2ClientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://cobrancas.api.efipay.com.br/v1/authorize
          scopes: {}