Apikey com seu Client ID.
Crie credenciais em Credenciais API (até 10 chaves ativas por usuário).
Documentação pública: https://app.dexspay.com/docs.php.
Esta documentação descreve como integrar sistemas externos (e-commerce, ERP, app mobile, etc.) com a plataforma DEXSPAY.
Base URL: https://app.dexspay.com · Docs: https://app.dexspay.com/docs.php
POST /api/v1/generate-pix.php com header Apikey.postback com a URL do seu sistema para receber confirmação de pagamento.POST /api/v1/cashout.php (requer saldo e IP autorizado se whitelist configurada).| Requisito | Onde verificar |
|---|---|
| Conta ativa e logada | Painel principal |
| Documentos aprovados | Necessário para acessar Credenciais API |
| PIN de 6 dígitos | Configurações → criar/revogar credenciais |
| Cash-in ativo | Admin ou perfil (depósitos PIX) |
| Cash-out ativo | Admin ou perfil (saques PIX) |
| Adquirente PIX configurada | Admin → usuário (Orus, AtivoPay, BullsPay, etc.) |
| Orus ativo (se adquirente ORUS) | Admin → Adquirentes PIX → Orus |
| IPs na whitelist | Credenciais API → IPs permitidos (obrigatório para saque, opcional para depósito) |
Envie o Client ID em todas as requisições. O Client Secret não deve ser enviado nas chamadas — serve apenas para guardar com segurança no momento da criação.
Múltiplas credenciais: crie uma chave por sistema (loja, ERP, homologação). Revogue chaves comprometidas sem afetar as demais.
Aliases de URL: /api/v1/cashin = generate-pix · /api/v1/cashout = cashout
Cria cobrança PIX para seu cliente pagar. Valor mínimo: R$ 6,00. CPF válido obrigatório.
Adquirentes suportados na API: Orus (padrão em muitas contas), AtivoPay/Asaas e BullsPay. A adquirente usada é a configurada na conta dona da credencial Apikey (admin → usuário → Adquirente PIX).
Guarde id ou internal_id retornado — é o mesmo valor enviado no postback. QR Code em pix ou pix_code.
postback ao criar o PIX. Sem ele, seu sistema não recebe aviso de pagamento confirmado.
Quando o PIX for confirmado (Orus, AtivoPay ou BullsPay), o DEXSPAY envia POST para a URL informada em postback.
id — referência interna (id / internal_id retornados na criação)value — valor bruto do depósito (string decimal, ex.: "120.00")status — sempre PAID quando confirmadoQuando outro sistema usa DEXSPAY como adquirente via API:
Apikey.POST /api/v1/generate-pix.php com campo postback apontando para o webhook do sistema externo.Erro comum: PIX pago e confirmado no DEXSPAY, mas sistema externo não atualiza → falta postback na criação ou endpoint externo não responde HTTP 200.
Transfere saldo BRL da conta para uma chave PIX. Valor mínimo: R$ 5,00. Debita valor + taxas do saldo.
Chave PIX (key): CPF, CNPJ, e-mail, telefone (+55) ou chave aleatória (EVP).
API REST autenticada com header Apikey (Client ID). Cada pagamento da folha vira uma transação oficial do DEXSPAY (PIX ou transferência). O status pago só muda após confirmação real do provedor.
Escopos: payroll:read, payroll:create, payroll:update, payroll:execute, payroll:cancel, payroll:recipients, payroll:reports. Credenciais sem scopes mantêm acesso total.
Webhooks HMAC (X-Bank-Signature: sha256=...): payroll.created, payroll.scheduled, payroll.processing, payroll.completed, payroll.failed, payroll.cancelled, payroll.paused, payroll.payment.paid e correlatos. O status financeiro acompanha a confirmação do provedor — não é marcado como pago só pelo envio da requisição.
API REST autenticada com header Apikey. O lote é apenas o agrupador: cada item tem idempotency_key, status, tarifa snapshot e comprovante próprios. O status pago só muda após confirmação do provedor (webhook/consulta) — nunca só porque a API externa aceitou o envio.
Escopos: batch:read, batch:create, batch:update, batch:execute, batch:cancel, batch:import. Credenciais sem scopes mantêm acesso total.
Cada item recebe uma chave no formato BANK-BATCH-{id}-ITEM-.... Reenviar a mesma requisição não cria nova transferência.
Webhooks internos: transfer.created, transfer.processing, transfer.completed, transfer.failed, transfer.cancelled, transfer.reversed, batch.completed, batch.partial, batch.failed. Eventos do provedor entram em POST /api/v1/webhooks/transfers com validação de assinatura, timestamp e idempotência (event_id). Importação CSV/XLSX nunca dispara pagamento — só prévia e validação.
Camada de segmentação do cliente (regras, badge, benefícios, limites e vínculo com o Plano de Tarifas). Não altera transações já processadas. Header Apikey. Escopos: tier:read, tier:admin.
Webhooks: tier.created, tier.updated, tier.activated, tier.deactivated, customer.tier_changed, customer.tier_promoted, customer.tier_downgraded, customer.tier_fee_plan_changed. Códigos: TIER_001 não encontrado, TIER_002 validação, TIER_003 exclusão bloqueada. Novos critérios/benefícios entram no catálogo de campos sem reescrever o módulo.
Programa de indicação de nível único. O cadastro pelo link /cadastro?ref=CODIGO vincula o indicado ao indicador de forma permanente. A comissão só é criada após a operação original ser confirmada. O markup do indicador é cobrado além da tarifa-base do DEXSPAY e creditado no saldo oficial (tipo COMISSAO_INDICACAO) após o prazo de retenção.
Escopos: referral:read, referral:create, referral:markup, referral:earnings. Credenciais sem scopes mantêm acesso total. Header: Apikey.
O backend valida obrigatoriamente os limites definidos pelo administrador. Markup negativo ou fora da faixa é recusado.
Webhooks HMAC (X-Bank-Signature: sha256=...): referral.created, referral.activated, referral.earning.created, referral.earning.pending, referral.earning.available, referral.earning.reversed, referral.program.suspended.
Valor mínimo: R$ 60,00.
Saques USDT ficam PENDING até aprovação manual/admin.
Mesmo fluxo do PIX → USDT: o usuário escolhe valor em BRL e a rede. Após o PIX, a hot wallet envia o gas nativo (POL, BNB, ETH ou xDAI) para a carteira destino.
Redes: POLYGON (POL), BSC (BNB), ETH (ETH), GNO (xDAI). A carteira destino, se omitida, usa a wallet da rede em Carteiras Crypto. Escopos: gas:create, gas:read ou gas:*.
| HTTP | Significado comum |
|---|---|
400 | Dados inválidos (CPF, valor mínimo, chave PIX, JSON malformado) |
401 | Apikey não enviada (cashout) |
403 | Client ID inválido/revogado, cash-in/out inativo, IP não autorizado |
404 | Usuário não encontrado |
405 | Método não permitido (use POST) |
502 | Falha na adquirente/gateway PIX |
503 | Gateway desativado, Orus inativo ou adquirente não suportada na API |
Formato típico de erro: {"statusCode": 403, "message": "Client id inválido ou revogado."}
| API | Auth | Uso |
|---|---|---|
/api/v1/generate-pix.php/api/v1/cashout.php/api/v1/payrolls/api/v1/gas.php |
Apikey (Client ID) | Integração externa — e-commerce, ERP, apps, folha de pagamento, compra de gas |
/api/v1/pix/charge/api/v1/pix/payment |
Sessão (login painel) | Uso interno no navegador — Swagger |
Para integrar outro sistema, use somente os endpoints com autenticação Apikey.
Consulta de status: não há endpoint Apikey para polling. Use o postback como confirmação oficial. Guarde internal_id / id retornados na criação.
postback é obrigatório em produção — sem ele o pagamento confirma no DEXSPAY mas não no seu sistema.id antes de liberar produto/serviço.id + PAID não deve creditar duas vezes).transaction_id, id interno e respostas para suporte.