Saldos e Extrato

Consulte saldos em tempo real e obtenha o extrato completo de transações.

Resumo Rápido

Use os endpoints de saldo para consultar o valor disponível em tempo real. O extrato fornece o histórico completo de todas as transações da conta.

1. Consultando Saldo

Endpoint

GET /api/v1/account/balance

Response 200 OK

{
  "success": true,
  "data": {
    "current": 1500.50,
    "blocked": 0,
    "available": "1500.50",
    "total": "1500.50",
    "currency": "BRL",
    "formatted": {
      "current": "R$ 1.500,50",
      "blocked": "R$ 0,00",
      "available": "R$ 1.500,50",
      "total": "R$ 1.500,50"
    },
    "updated_at": "2026-07-21T10:30:00Z"
  }
}

Campos da Resposta

Campo	Tipo	Descrição
`current`	float	Saldo atual (numérico)
`blocked`	float	Valor bloqueado/reservado
`available`	string	Saldo disponível para uso
`total`	string	Saldo total (current - blocked)
`currency`	string	Moeda (BRL, USDT, BTC, etc)
`formatted`	object	Valores formatados para exibição

2. Múltiplos Saldos

Para contas com múltiplas moedas, use o endpoint de balances:

Endpoint

GET /api/v1/account/balances

Response 200 OK

{
  "success": true,
  "data": [
    {
      "currency": "BRL",
      "current": 1500.50,
      "available": "1500.50"
    },
    {
      "currency": "USDT",
      "current": 250.00,
      "available": "250.00"
    },
    {
      "currency": "BTC",
      "current": 0.005,
      "available": "0.00500000"
    }
  ]
}

3. Extrato de Transações

Endpoint

POST /api/v1/transactions/list

Request Body (Filtros Opcionais)

{
  "page": 1,
  "per_page": 20,
  "date_ini": "2026-07-01",
  "date_fin": "2026-07-31",
  "tipo": "credito",
  "categoria": "pix_recebido"
}

Filtros Disponíveis

Filtro	Tipo	Descrição
`page`	int	Página (default: 1)
`per_page`	int	Itens por página (default: 20, max: 100)
`date_ini`	string	Data inicial (YYYY-MM-DD)
`date_fin`	string	Data final (YYYY-MM-DD)
`tipo`	string	Tipo: `credito`, `debito`
`categoria`	string	Categoria da transação

4. Categorias de Transações

Categoria	Descrição
`pix_recebido`	PIX recebido (entrada)
`pix_enviado`	PIX enviado (saída)
`pix_automatico`	Cobrança PIX Automático
`split`	Distribuição de split
`tarifa`	Tarifa cobrada
`taxa`	Taxa de serviço
`crypto_deposito`	Depósito em criptomoeda

5. Exemplo Completo

Exemplo com cURL

# Consultar saldo
curl -X GET "https://ajnapay.com.br/api/v1/account/balance" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Accept: application/json"

# Listar transações do mês
curl -X POST "https://ajnapay.com.br/api/v1/transactions/list" \
  -H "Authorization: Bearer SEU_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "date_ini": "2026-07-01",
    "date_fin": "2026-07-31",
    "per_page": 50
  }'

Anterior: Webhooks Próximo: Crypto