Pix and BolePix with Banco Inter for WooCommerce — payments in Brazil

CatCode Pix with Banco Inter for WooCommerce adds Pix to WooCommerce, connected straight to the API of your Banco Inter business account (Inter Empresas). There is no intermediary: the charge is created in your account, the money lands on your Pix key and the integration credentials are your own. The shop works in Brazilian reais (BRL).

What the free version does

Every order gets a dynamic Pix charge for the order total with an expiry you choose (60 minutes by default). The buyer sees the QR code and the “Pix Copia e Cola” code on the thank-you page, in “My account” and in the e-mail. The module draws the QR picture itself; the code is not sent to any QR service. An order is marked as paid only after the module reads the charge back from the bank: the bank webhook just says it is time to ask. A Pix of a different amount puts the order on hold with a note. The order page switches to “Pagamento recebido” by itself, even when the webhook is late. The .crt and .key files of the integration are uploaded on the settings screen and stored encrypted in the database together with the Client Secret. The site administrator gets an e-mail 30 days and 7 days before the certificate ends. Three buttons tell in plain words what the bank answered: check the connection, register the webhook and create a test Pix charge of R$ 1,00. The order screen has a “Check payment status” button. It works with the classic and the block checkout and with HPOS, in production and in the test environment of the bank. Interface languages: português do Brasil and English.

What Pro adds

BolePix: a second payment method, a Banco Inter boleto with a Pix QR code inside. You set the due date in days, how many days after it the bank still takes the payment, a late fine in percent and monthly interest. The buyer gets the boleto line, the Pix code and the PDF. Unpaid orders cancel themselves: once an hour the module asks the bank, and an order whose Pix code or BolePix has expired unpaid is cancelled, and WooCommerce returns its products to stock. An order cancelled in the shop cancels its unpaid boleto at the bank. A Pix refund (full or partial) from WooCommerce goes to the bank as a devolução. A discount for paying with Pix: a percentage of the products total (after coupons, without shipping) on the classic and the block checkout. The log keeps the last 200 calls to the bank with their answers, without keys or buyer data. Updates of the module come from catcode.com.ua.

Good to know before you start

• You need an Inter Empresas business account with an API integration. The module does not open the account or the integration; you create them in the Inter internet banking.
• Pix is shown only when the shop currency is BRL and everything is set: Client ID, Secret, certificate, key and Pix key.
• The certificate of an integration is valid for one year. The screen shows the end date and e-mails go out 30 and 7 days before it. After the secret salts in wp-config change or the database is moved to another site, the certificate files have to be uploaded again.
• The bank limits tokens to five a minute. The module caches a token for about 58 minutes, separately for each set of permissions.
• In the free version an unpaid order stays on hold after the Pix code ends. Auto-cancel is part of Pro.
• Refunds work for Pix orders. The bank API for BolePix does not give the payment identifier a refund needs, so such orders are refunded at the bank itself.
• Pix Automático (subscriptions) is not in version 1.0.0.
• The smallest boleto the bank accepts is R$ 2,50.

How it works, step by step

1. In the Inter Empresas internet banking open “Soluções para sua empresa” → “Nova Integração”, create an integration with the permissions cob.write, cob.read, webhook.write and webhook.read (for Pro also pix.write, pix.read, boleto-cobranca.write, boleto-cobranca.read), copy the Client ID and the Client Secret and download the certificate and the key.
2. In WooCommerce → Banco Inter choose the environment, paste the credentials, upload the .crt and .key files, enter your Pix key and save.
3. Press “Testar conexão”, then “Cadastrar o webhook no banco”.
4. In WooCommerce → Settings → Payments enable “Pix (Banco Inter)” and place an order.

Under the hood

• The Client Secret, the certificate and the key are stored encrypted in the database, not in a public folder.
• Every request to the bank presents the certificate of your integration.
• An order is settled by the bank answer to the charge request, not by the webhook body.
• Simultaneous webhooks and polls give one note and one stock reduction.
• The public QR, status and boleto addresses are protected by the order key.
• HPOS, classic and block checkout; languages: português do Brasil, English.

How to install

1. Plugins → Add New → Upload Plugin: choose the zip and activate it.
2. In WooCommerce → Banco Inter choose the environment and enter the integration credentials.
3. Upload the .crt and .key files and enter the Pix key.
4. Press “Testar conexão” and “Cadastrar o webhook no banco”, then enable Pix among the payment methods.

The module is not on wordpress.org yet: the free version and Pro are one archive from this page. Without a key it works as the free version.