Carteiras
POST /pix/carteiras cadastra as credenciais do banco. GET /pix/bancos lista os campos exigidos por instituição.
Produto
API de PIX.
Você envia a cobrança em JSON. A API cria no banco da carteira e devolve o QR Code e o copia e cola para o seu checkout.
Cobranças
POST /pix/cobrancas cria PIX instantâneo ou com vencimento. A resposta traz txid, copia_cola e o QR Code.
Webhook
Cadastre a URL do seu sistema. Quando o pagamento for confirmado, a API marca a cobrança como paga e notifica você.
Devolução
POST /pix/cobrancas/{id}/devolucao solicita devolução total ou parcial no padrão Bacen, no banco da carteira.
Bancos
Instituições da integração.
Hoje a emissão no PSP está disponível para Banco do Brasil e Sicredi. Os demais bancos do catálogo entram na sequência com o mesmo formato de carteira.
-
Banco do Brasil 001 · Disponível -
Santander 033 · Em breve -
Inter 077 · Em breve -
Itaú 341 · Em breve -
Efí 364 · Em breve -
Asaas 461 · Em breve -
Sicredi 748 · Disponível -
Sicoob 756 · Em breve
Fluxo
Do JSON ao QR Code.
- ativa — a cobrança foi criada no banco. Use copia_cola ou o QR no checkout.
- paga — o PSP confirmou o pagamento. A API grava o end_to_end_id e notifica o seu webhook.
- parcialmente_devolvida — houve devolução parcial do valor recebido.
- devolvida — o valor disponível foi devolvido por completo.
Exemplo
POST https://api.apisimples.com/v1/pix/cobrancas com a carteira e o valor. A resposta traz copia_cola e, quando o banco informar, a location do QR.
Cadastre a carteira e emita o primeiro PIX.
A chave do emitente libera as rotas. O certificado e as credenciais OAuth ficam na carteira do banco.