Efí - pagamentos.dev

Sobre a Efí

A Efí oferece infraestrutura financeira e APIs de pagamento. A interface unificada do pagamentos.dev é deliberadamente focada na API Pix para não misturar credenciais e protocolos de produtos diferentes. Consulte a documentação oficial da API Pix Efí.

Métodos e recursos

pix — cobrança imediata com QR Code
Consulta, atualização e cancelamento de cobranças
Webhooks da API Pix

Credenciais, certificado e sandbox

Crie uma aplicação Pix para obter clientId, clientSecret, chave Pix e o certificado P12/PFX. O sandbox possui credenciais e host próprios.

pagamentos.ts

import { readFile } from 'node:fs/promises'
import { Pagamentos, efi } from 'pagamentos'

const pfx = await readFile(process.env.EFI_PFX_PATH!)

export const pg = new Pagamentos({
  providers: [
    efi({
      clientId: process.env.EFI_CLIENT_ID!,
      clientSecret: process.env.EFI_CLIENT_SECRET!,
      pixKey: process.env.EFI_PIX_KEY!,
      mode: 'sandbox',
      pfx,
      pfxPassphrase: process.env.EFI_PFX_PASSPHRASE,
      signingSecret: process.env.EFI_WEBHOOK_SECRET
    })
  ]
})

Nunca inclua o certificado, sua senha ou as credenciais no repositório. A API Pix exige autenticação mTLS também no sandbox.

O signingSecret protege a URL quando você usa o modo de webhook sem mTLS documentado pela Efí. Veja também Pix e webhooks.