naftiko: 1.0.0-alpha2
info:
  label: Efí Pay — CNAB Statements
  description: >-
    Schedule recurring CNAB statement extraction, list generated files,
    download via API, and provision an SFTP key pair for automated pickup.
  tags:
    - Efí Pay
    - Statements
    - CNAB
    - Reconciliation
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      EFI_EXTRATOS_CLIENT_ID: EFI_EXTRATOS_CLIENT_ID
      EFI_EXTRATOS_CLIENT_SECRET: EFI_EXTRATOS_CLIENT_SECRET
      EFI_EXTRATOS_CERT_PATH: EFI_EXTRATOS_CERT_PATH
capability:
  consumes:
    - type: http
      namespace: efi-extratos
      baseUri: https://extratos.api.efipay.com.br
      description: Efí Pay CNAB statements API
      resources:
        - name: files
          path: /v1/extrato-cnab/arquivos
          operations:
            - name: listStatementFiles
              method: GET
              description: List generated CNAB files
        - name: download
          path: /v1/extrato-cnab/download/{nome_arquivo}
          operations:
            - name: getStatementFile
              method: GET
              description: Download a CNAB statement file
        - name: schedule
          path: /v1/extrato-cnab/agendar
          operations:
            - name: createStatementRecurrency
              method: POST
              description: Schedule recurring CNAB generation
        - name: sftp-keys
          path: /v1/extrato-cnab/gerar-chaves
          operations:
            - name: createSftpKey
              method: POST
              description: Provision SFTP key pair