Bem-vindo à documentação da nossa API de pagamentos.
Somos uma plataforma de TEF (Transferência Eletrônica de Fundos) 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. Você não desenvolve nada de
hardware nem lida com a adquirente diretamente.
Como funciona
O fluxo de uma cobrança tem quatro passos:
- Você cria a cobrança. Seu sistema chama
POST /transactionsinformando o
lojista, o valor e o meio de pagamento. A cobrança nasce com statuspending. - A maquininha assume. A Smart POS do lojista pega a cobrança e mostra o
valor na tela. - O cliente paga. Ele passa, insere ou aproxima o cartão na maquininha.
- O resultado volta. Você acompanha o desfecho — por polling em
GET /transactions/{id}, ou recebendo um webhook a cada mudança.
Os três atores
Toda a API gira em torno de três coisas:
| Ator | O que é |
|---|---|
| Partner | Você, a software house que integra. Sua conta tem um token único. |
| Merchant | O lojista (o estabelecimento do seu cliente). Agrupa terminais. |
| Terminal | A maquininha Smart POS, vinculada a um lojista. |
Os nomes de cada campo e recurso estão explicados na página Glossário.
O que você precisa
- Um token de integrador, disponível no seu painel. Ele identifica a sua
conta em toda chamada. - Uma maquininha Smart POS compatível — um aparelho com tela e Android, como
a Ingenico AXIUM, rodando o nosso app. Leitores de cartão sem tela (aqueles
que só conectam ao celular) não funcionam. Veja a página de compatibilidade. - A URL base da API, informada no painel.
Autenticação
Toda requisição leva o header:
Authorization: Bearer SEU_TOKENO token identifica a sua conta — por isso você nunca informa qual é o parceiro
no corpo das chamadas. Não há login de usuário nem PIN.
Valores
Todos os valores são inteiros em centavos. R$ 10,50 é 1050; R$ 150,00 é
15000. Nunca envie ponto nem vírgula.
Próximas páginas
- Glossário — o que cada nome em inglês representa.
- Status da transação — o significado de cada estado.
- Primeiros passos — do token à primeira cobrança de teste.