Merchant

Consultar saldo e carteiras do merchant

Retorna o panorama financeiro completo do merchant autenticado, incluindo:

  • Resumo consolidado dos saldos (disponível, pendente, reservado, gravado e liberado para saque)
  • Todas as carteiras configuradas, com status operacional, limites, provedores e saldos individuais

withdrawable (available - lien) é o valor efetivamente liberado para saque. blocked (reserva de saques em voo) já saiu de available no momento da reserva — não é subtraído de novo. lien (gravame de disputa MED em análise) continua contado em available, mas reduz withdrawable enquanto a disputa estiver aberta.

post/balance

Request

  • Base URL: https://api.virtualpay.online/v2
  • URL: https://api.virtualpay.online/v2/balance
  • Auth: API key in header x-client-id

Response

Dados financeiros obtidos com sucesso

Example response

{
  "summary": {
    "available": 18500.75,
    "pending": 3200,
    "blocked": 1500,
    "lien": 200,
    "withdrawable": 17000.75
  },
  "wallets": [
    {
      "uuid": "a2f8c4c0-1234-4e6b-9b5d-9c1f2c1d8a7b",
      "code": "pix",
      "name": "Carteira PIX",
      "status": {
        "wallet": "active",
        "type": "active"
      },
      "balances": {
        "available": 12000,
        "pending": 500,
        "blocked": 1000,
        "lien": 200,
        "withdrawable": 11000
      },
      "currency": {
        "code": "BRL",
        "symbol": "R$"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.