Consultar saldo

Retorna a composição atual do saldo da conta autenticada: valores disponíveis, em liquidação, depósitos de garantia, bloqueios cautelares e reservas de chargeback. Todos os valores em centavos.

GET/accounts/balance

Autenticação

HTTP Basic Auth. Envie sua secret key no header:

Authorization: Basic {base64(secret:SUA_SECRET_KEY)}

Respostas

200

Saldo retornado com sucesso. A resposta também inclui um header x-trace-id que você pode correlacionar com nossos logs.

JSON

{
  "balance": 150000,
  "balanceCreditCard": 50000,
  "pendingBalance": 20000,
  "garanteeBalance": 30000,
  "precautionaryBlock": 10000
}

401

API key ausente, malformada ou revogada.

JSON

{
  "statusCode": 401,
  "message": "Unauthorized"
}

403

API key válida, mas sem a permissão viewBalance.

JSON

{
  "statusCode": 403,
  "message": "You do not have permission to access this resource"
}

Exemplos

cURL

curl -X GET "https://api.pagnovo.com/accounts/balance" \
  -H "Authorization: Basic $(echo -n 'secret:SUA_SECRET_KEY' | base64)"

JavaScript

const token = Buffer.from("secret:" + process.env.PAGNOVO_SECRET_KEY).toString("base64");

const res = await fetch("https://api.pagnovo.com/accounts/balance", {
  headers: { Authorization: `Basic ${token}` },
});

const traceId = res.headers.get("x-trace-id");
const balance = await res.json();

console.log("trace:", traceId);
console.log("Disponível (R$):", balance.balance / 100);

Python

import base64, os, requests

token = base64.b64encode(
    f"secret:{os.environ['PAGNOVO_SECRET_KEY']}".encode()
).decode()

res = requests.get(
    "https://api.pagnovo.com/accounts/balance",
    headers={"Authorization": f"Basic {token}"},
)

print("trace:", res.headers.get("x-trace-id"))
balance = res.json()
print(f"Disponível (R$): {balance['balance'] / 100:.2f}")