BTG Pay SDK
Esta documentação está em desenvolvimento. As páginas de Configuração, Comissionamento, Impressão, Template de Comprovante e Referência da API estão completas e prontas para uso em integração. As demais serão expandidas com o lançamento do produto.
O BTG Pay SDK é a camada de integração entre o aplicativo do parceiro e os serviços de pagamento e impressão disponíveis no terminal POS. O parceiro recebe um único artefato — o arquivo btg-pay-client.aar — que contém o BtgPayClient e todas as interfaces necessárias para operar o terminal.
O serviço BTG Pay (com.btg.pay.service) já vem instalado no terminal. A comunicação entre o app do parceiro e o serviço acontece via AIDL, mas o BtgPayClient encapsula toda essa camada — o parceiro não interage com o AIDL diretamente.
App do Parceiro → btg-pay-client.aar (BtgPayClient) → Serviço BTG Pay → Hardware / Servidores
O que o SDK oferece no momento
- Comissionamento — ativação do terminal junto aos servidores de pagamento, com troca de certificados
- Impressão — impressão de texto, imagem, QR code e avanço de papel
- Template de comprovante — substituição do comprovante padrão do BTG por um SVG customizado
- Pagamento — fluxo completo de pagamento com múltiplos meios (débito, crédito, PIX). O SDK já suporta pagamentos; a documentação desta feature será publicada em versão futura
Ordem de leitura
| # | Página | Conteúdo |
|---|---|---|
| 1 | Introdução (esta página) | O que é o SDK e como a documentação está organizada |
| 2 | Configuração | Pré-requisitos, dependências, conexão com o serviço |
| 3 | Comissionamento | Ativação do terminal e troca de certificados |
| 4 | Impressão | Impressão standalone de texto, imagem e QR code |
| 5 | Template de Comprovante | Customização do comprovante de venda via SVG |
| 6 | Referência da API | Assinaturas, tipos e códigos de erro |