naftiko: 1.0.0-alpha2
info:
  label: Efí Pay Open Finance — Pix Payment Initiation
  description: >-
    Initiate a Pix payment from any participating Brazilian bank/fintech via Efí
    Pay's Open Finance gateway. List participants, start a payment, list and
    refund payments. Requires x-idempotency-key per request.
  tags:
    - Efí Pay
    - Open Finance
    - Payment Initiation
    - Pix
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      EFI_OPENFINANCE_CLIENT_ID: EFI_OPENFINANCE_CLIENT_ID
      EFI_OPENFINANCE_CLIENT_SECRET: EFI_OPENFINANCE_CLIENT_SECRET
      EFI_OPENFINANCE_CERT_PATH: EFI_OPENFINANCE_CERT_PATH
capability:
  consumes:
    - type: http
      namespace: efi-openfinance
      baseUri: https://openfinance.api.efipay.com.br
      description: Efí Pay Open Finance (mTLS + idempotency required)
      resources:
        - name: oauth
          path: /v1/oauth/token
          operations:
            - name: ofAuthorize
              method: POST
              description: Issue Open Finance access token
        - name: participants
          path: /v1/participantes/
          operations:
            - name: ofListParticipants
              method: GET
              description: List Open Finance participants
        - name: pix-payment
          path: /v1/pagamentos/pix
          operations:
            - name: ofStartPixPayment
              method: POST
              description: Initiate a Pix payment from a third-party bank
            - name: ofListPixPayment
              method: GET
              description: List initiated Pix payments
        - name: pix-payment-refund
          path: /v1/pagamentos/pix/{identificadorPagamento}/devolver
          operations:
            - name: ofDevolutionPix
              method: POST
              description: Refund an initiated Pix payment