Integre com o Lumens PAY.

Base da API:

Autenticação

Ative a API no plano da conta e gere um token em Conta → API. O segredo aparece uma única vez. Use no servidor da sua aplicação, no cabeçalho Authorization: Bearer SEU_TOKEN.

Tokens API usam o prefixo sk_live_. Tokens Wallet, destinados a transferências, usam wk_live_ e exigem o escopo específico e um plano com transferência habilitada.

Revogar o token interrompe novas chamadas. Os limites de chamadas e o histórico ficam no painel.

Recursos disponíveis

Método	Rota	Escopo
GET	/v1/balance	balance:read
GET	/v1/transactions	transactions:read
GET	/v1/transactions/:id	transactions:read
POST	/v1/charges	charges:write
GET	/v1/charges e /v1/charges/:id	charges:read
POST	/v1/pix, /v1/ted, /v1/withdraw	pix:write, ted:write ou withdraw:write (Wallet)

Valores em reais, como número decimal. O valor de transferência é bruto; a tarifa é descontada para calcular o líquido enviado.

Criar uma cobrança PIX

A resposta contém charge com ID, estado e dados de pagamento disponíveis no provedor. Credenciais do parceiro e recursos do plano precisam estar configurados.

Transferências e repetição

Em toda transferência, envie o cabeçalho Idempotency-Key com um identificador único de 16 a 128 caracteres. Ao repetir a mesma operação, reutilize a chave. Não use uma chave nova para contornar um resultado pendente.

POST /v1/pix
Authorization: Bearer wk_live_...
Idempotency-Key: pedido-saida-00000001
Content-Type: application/json

{"amount": 25.00, "pix_key": "destino@example.com", "pix_key_type": "EMAIL"}

Se a resposta do parceiro for incerta, o valor permanece reservado e a operação vai para conciliação. Isso evita reenvio indevido.

Estados e erros

401 token inválido; 403 conta, plano, escopo ou limite; 409 operação repetida com outros dados ou pendente; 422 divergência de confirmação; 429 limite de chamadas; 503 recurso aguardando configuração ou homologação.

Pagamento por QR Code, split de saída, cripto e provisionamento de webhooks por API externa não estão liberados nesta versão. A documentação descreve apenas os recursos expostos aqui.