Preloader
XXX PAY
Docs públicas da API Guia para seller integrar autenticação, PIX, saldo e callbacks.
Guia do seller

Integre rápido, teste com clareza e publique com segurança.

Organizamos a documentação para você sair da credencial até o callback sem se perder no caminho.

Ativo hoje na XXXPay

  • PIX In com QR Code e copia e cola
  • PIX Out com callback de status
  • Consulta de saldo e transação
Criar conta na XXXPay
Saldo

Consulte o saldo da carteira do seller.

Esta rota usa autenticação por headers ci e cs. Ela é útil para conciliação, exibição de saldo operacional e checagens antes de saque.

GET https://api.xxxpay.online/api/users/balance Headers ci/cs
curl --request GET 'https://api.xxxpay.online/api/users/balance' \
  --header 'ci: seu_client_id' \
  --header 'cs: seu_client_secret'
{
  "message": "Saldo do usuario obtido com sucesso",
  "data": {
    "balance": "1.50",
    "total_balance": "1.50",
    "balance_block": "0.00"
  }
}

balance

Saldo disponível da carteira, pronto para uso operacional.

total_balance

Espelho do saldo total retornado pela carteira ativa.

balance_block

Valor retido ou indisponível no momento da consulta.