Início Rápido
Comece a integrar com nossa API e SDK em poucos minutos.
Bem-vindo à documentação oficial! Nossa plataforma oferece uma solução completa de sub-adquirência e Banking as a Service (BaaS) para facilitar a integração de transações financeiras.
Nossos Serviços
Nossa API oferece suporte completo para diversos métodos de pagamento e operações financeiras:
PIX
Gere cobranças instantâneas via PIX com QR Code e links de pagamento.
Cartão de Crédito
Processe pagamentos com cartão de crédito com tokenização segura.
Boleto Bancário
Emita boletos bancários para pagamentos parcelados ou à vista.
Saque
Realize saques para chaves PIX de forma rápida e segura.
Consulta de Saldo
Consulte saldo disponível e pendente em tempo real (BaaS).
Guia de Início Rápido
Siga este passo a passo para começar a integrar nossa API em poucos minutos:
Obter a Chave de Cash-In
Dentro da plataforma, acesse a seção de desenvolvedores e copie a Chave de Cash-In. Esta chave permite criar e consultar pedidos, além de tokenizar cartões.
A Chave de Cash-In pode ser usado no client-side, pois permite apenas criar e consultar pedidos.
Configurar o Webhook
Na plataforma, configure a URL do webhook que receberá notificações de confirmação de pagamento. O webhook será enviado no seguinte formato:
{
"type": "order.paid",
"timestamp": "",
"data": {
"order_id": "ord_123456789",
"status": "paid",
"amount": 10000,
"currency": "BRL",
"payment_method": "pix",
"paid_at": "2024-01-15T10:30:00Z",
"customer": {
"name": "João Silva",
"email": "joao@exemplo.com"
}
}
}Gerar o Primeiro Pedido
Use o endpoint de criação de pedidos passando a chave no header Authorization no formato Basic:
curl -X POST https://api.exemplo.com/v1/orders \
-H "Authorization: Basic SUA_CHAVE_DE_CASH_IN" \
-H "Content-Type: application/json" \
-d '{
"amount": 10000,
"payment_method": "pix",
"customer": {
"name": "João Silva",
"email": "joao@exemplo.com"
}
}'A resposta conterá os dados do pedido:
{
"id": "ord_123456789",
"status": "pending",
"amount": 10000,
"payment_method": "pix",
"payload": {
"code": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-426655440000520400005303986540510.005802BR5925NOME DO RECEBEDOR6009SAO PAULO62070503***63041D3D"
},
"checkout_link": "https://pagamento.exemplo.com/pay/ord_123456789",
"created_at": "2024-01-15T10:00:00Z"
}Exibir o PIX ou Link de Pagamento
Você pode exibir o PIX de duas formas:
Opção 1: Usar o código PIX (payload.code)
Use o payload.code da resposta para gerar um QR Code na tela:
// Exemplo usando uma biblioteca de QR Code
import QRCode from 'qrcode';
const qrCodeData = response.payload.code;
const qrCodeImage = await QRCode.toDataURL(qrCodeData);
// Exibir qrCodeImage na telaOpção 2: Usar o link de pagamento
Redirecione o cliente para o checkout_link fornecido na resposta:
window.location.href = response.checkout_link;O link de pagamento funciona para todos os métodos de pagamento (PIX, Cartão e Boleto), facilitando a experiência do usuário.
Realizar um Saque
Para realizar um saque, você precisará da Chave de Cash-out (diferente da chave de cash-in). Use o endpoint de saque:
curl -X POST https://api.exemplo.com/v1/payments \
-H "Authorization: Bearer SUA_CHAVE_DE_CASH_OUT" \
-H "Content-Type: application/json" \
-d '{
"amount": 5000,
"pix_key": "usuario@exemplo.com"
}'IMPORTANTE: A Chave de Cash-Out nunca deve ser exposto no client-side. Sempre use-o apenas no backend para garantir a segurança das operações.
Próximos Passos
Agora que você já conhece o básico, explore nossa documentação completa:
Autenticação
Entenda em detalhes os tipos de chaves e como usá-las corretamente.
Como Gerar Pedido
Guia completo para criar pedidos com PIX, Cartão ou Boleto.
Como Fazer Saque
Aprenda a realizar saques e consultar saldo de forma segura.
Referência de API
Explore todos os endpoints disponíveis com exemplos interativos.
Precisa de Ajuda?
Se tiver qualquer dúvida durante a integração, entre em contato com nosso suporte técnico.