#PIX

Plan PIX account plugin activation for Brazil.

#Overview

PIX is Brazil's instant payment rail operated by Banco Central do Brasil. It supports transfers between transactional accounts using account details, Pix keys, and QR-based payment initiation.

The Bloque SDK does not expose a public accounts.pix client yet. Treat this page as the format and activation guide for teams preparing a PIX rollout with Bloque.

#Supported Formats

PIX commonly identifies recipients through Pix keys registered in DICT, the Banco Central do Brasil directory for transactional account identifiers.

#QR Initiation

PIX QR payloads use Brazil's BR Code profile for payment initiation. For implementation planning, keep QR parsing and validation separate from key registration:

• static and dynamic QR payloads can carry receiver information, amount, references, and merchant data
• BR Code payloads are structured as EMV-style tag-length-value data
• the SDK should not assume QR payloads are plain Pix keys

#Activation Checklist

Before scheduling the sales call, prepare:

• target country and entity type for the origin using PIX
• expected use case: receive, payout, QR collection, or reconciliation
• required key formats: CPF/CNPJ, phone, email, EVP, QR, or a subset
• expected webhook and reporting requirements
• compliance status for the holders that will use the rail

#Example

Use this pattern to prepare the information needed for activation. The full example is available at examples/accounts/pix/prepare-pix-plugin.ts.

type PixKeyType = 'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP';

const activationUrl = 'https://calendly.com/hi-bloque/15-min';

const request = {
  rail: 'pix',
  activationUrl,
  country: 'BRA',
  useCase: 'receive',
  requestedKeyTypes: ['CPF', 'CNPJ', 'PHONE', 'EMAIL', 'EVP'] satisfies PixKeyType[],
  sampleKey: {
    type: 'PHONE' satisfies PixKeyType,
    value: '+5511999999999',
  },
  webhookUrl: 'https://api.example.com/webhooks/pix',
};

console.log('PIX activation request:', request);
console.log('Schedule activation:', activationUrl);

#Notes

• This page is documentation-only; do not call accounts.pix in production code until a public SDK client is released.
• PIX keys must be unique according to PIX/DICT rules and may be subject to ownership, claim, portability, and fraud restrictions.
• PIX QR and Pix key flows should be modeled as distinct inputs even when both resolve to the same payment rail.

#References

• Banco Central do Brasil PIX
• Banco Central do Brasil DICT API
• Banco Central do Brasil Manual de Padrões para Iniciação do Pix

#Next Steps

• Accounts Overview
• BRE-B
• Account Webhooks