Efí Pay Cobranças — Billing Workflow

naftiko: 1.0.0-alpha2
info:
  label: Efí Pay Cobranças — Billing Workflow
  description: >-
    End-to-end billing workflow against the Efí Pay Cobranças API: authorize,
    create a one-step charge (boleto or card), poll status, optionally settle
    or cancel, and refund card charges. Covers the most common merchant
    integration path for Brazilian boletos and credit-card billing.
  tags:
    - Efí Pay
    - Cobranças
    - Boleto
    - Credit Card
    - Billing
  created: '2026-05-24'
  modified: '2026-05-24'
binds:
  - namespace: env
    keys:
      EFI_COBRANCAS_CLIENT_ID: EFI_COBRANCAS_CLIENT_ID
      EFI_COBRANCAS_CLIENT_SECRET: EFI_COBRANCAS_CLIENT_SECRET
capability:
  consumes:
    - type: http
      namespace: efi-cobrancas
      baseUri: https://cobrancas.api.efipay.com.br
      description: Efí Pay Cobranças (Billing) API
      resources:
        - name: authorize
          path: /v1/authorize
          operations:
            - name: authorize
              method: POST
              description: Issue OAuth2 access token (HTTP Basic, grant_type=client_credentials)
        - name: charge
          path: /v1/charge
          operations:
            - name: createCharge
              method: POST
              description: Create a new charge
            - name: listCharges
              method: GET
              description: List charges (use /v1/charges)
        - name: charge-detail
          path: /v1/charge/{id}
          operations:
            - name: detailCharge
              method: GET
              description: Retrieve a charge by id
        - name: charge-onestep
          path: /v1/charge/one-step
          operations:
            - name: createOneStepCharge
              method: POST
              description: Create charge with payment method in one call
        - name: charge-pay
          path: /v1/charge/{id}/pay
          operations:
            - name: definePayMethod
              method: POST
              description: Assign payment method (banking_billet or credit_card)
        - name: charge-cancel
          path: /v1/charge/{id}/cancel
          operations:
            - name: cancelCharge
              method: PUT
              description: Cancel a charge
        - name: charge-settle
          path: /v1/charge/{id}/settle
          operations:
            - name: settleCharge
              method: PUT
              description: Manually mark a charge as settled
        - name: charge-refund
          path: /v1/charge/card/{id}/refund
          operations:
            - name: refundCard
              method: POST
              description: Refund a card charge