Documentação da API — Aster Code

API de pagamentos (TEF) para maquininhas Smart POS. Sua software house
integra uma única vez e passa a oferecer, dentro do próprio sistema, pagamento
com cartão na maquininha do lojista — hoje crédito e débito, com Pix e voucher
no roteiro.

Você programa contra a nossa API; o pagamento acontece na maquininha física do
lojista; o resultado volta para o seu sistema. Sem desenvolver hardware, sem
falar com a adquirente diretamente.

📘
Comece por aqui
Toda a referência da API está pronta pra uso.
→ Acessar a documentação da API

Como funciona, em 4 passos

Você cria a cobrança — uma chamada informando o lojista, o valor e o meio de pagamento.
A maquininha assume — a Smart POS do lojista pega a cobrança e mostra o valor na tela.
O cliente paga — passa, insere ou aproxima o cartão.
O resultado volta — você acompanha o desfecho por consulta ou por webhook.

O que você vai encontrar aqui

Visão geral e conceitos — o que é cada coisa e como o fluxo se encaixa.
Glossário — o que cada nome em inglês representa.
Status da transação — o significado de cada estado.
Referência da API — todos os endpoints, com exemplos de requisição e resposta.

🚀
O essencial
Na maioria das integrações, você só precisa de três endpoints: criar a
cobrança, consultar o resultado e (quando precisar) estornar.

Antes de começar, confira

Um token de integrador, disponível no seu painel — ele identifica sua conta em toda chamada.
Uma maquininha Smart POS compatível — um aparelho com tela e Android, rodando o nosso app.
A URL base da API, informada no painel.

⚠️
Nem toda maquininha serve
O nosso app roda em Smart POS (com tela e Android). Leitores de cartão sem
tela — aqueles que só conectam ao celular — não são compatíveis.

Pronto pra integrar? Acesse a documentação da API →