Pular para o conteúdo
SimPixSimPix Docs

Saldo

Método Endpoint Descrição
GET /api/balance Retorna o saldo atual com breakdowns (balance, blocked, reserve, processing)

Consultar saldo

Seção intitulada “Consultar saldo”

GET /api/balance

GET /api/balance — Consultar saldo
curl --request GET \
  --url https://api.simpixpagamentos.com/api/balance \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

Resposta

Seção intitulada “Resposta”
200 — Balance returned
{
  "code": 200,
  "content": {
    "currency": "BRL",
    "balance": 1250.75,
    "blocked": 120.00,
    "reserve": 80.00,
    "processing": 45.50
  },
  "message": "Balance returned",
  "timestamp": "2025-02-19T17:15:26.703Z"
}

Breakdowns

Seção intitulada “Breakdowns”
Campo Descrição
balance Saldo disponível para uso (ex.: solicitar saques)
blocked Valores bloqueados (ex.: disputas em andamento)
reserve Valores mantidos em reserva
processing Valores em processamento, ainda não liquidados

Filtros

Seção intitulada “Filtros”

Por moeda (currency)

Seção intitulada “Por moeda (currency)”
GET /api/balance — Filtrar por moeda
curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/balance?currency=BRL' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'

Por tipo (type)

Seção intitulada “Por tipo (type)”
GET /api/balance — Filtrar por tipo
curl --request GET \
  --url 'https://api.simpixpagamentos.com/api/balance?type=FIAT' \
  --header 'x-api-key: <API_KEY>' \
  --header 'x-token: <TOKEN>' \
  --header 'x-timezone: America/Sao_Paulo'