---
title: "Consultar el saldo que cargarían tus envíos"
method: GET
path: "/balance"
tags: ["balance"]
---

# Consultar el saldo que cargarían tus envíos

`GET /balance`

## Request

- Base URL: `https://api.enviadores.com.mx/api/v1`
- URL: `https://api.enviadores.com.mx/api/v1/balance`
- Auth: HTTP bearer

Sin `X-PDV-ID`: el saldo del usuario de la llave. Con `X-PDV-ID` (llaves admin, misma allowlist que `POST /shipments`): el fondo del punto de venta — exactamente el principal que un envío bajo ese header cargaría. `available` es lo gastable; `held` son autorizaciones pendientes; `balance` = available + held. Requiere scope `balance:read`.

## Headers

- `X-PDV-ID` string

## Response `200`

Saldo del principal.

- object
  - `success` unknown, required
  - `data` object, required
    - `balance` number, required: available + held (total del principal en el libro mayor).
    - `held` number, required: Autorizaciones pendientes (holds).
    - `available` number, required: Lo gastable por un envío nuevo.
    - `currency` 'MXN', required
    - `scope` object, required
      - `type` 'user' | 'pdv', required
      - `id` string, required
  - `requestId` string, required: Correlación de logs; también en el header `X-Request-Id`.

## Other responses

- `401`: `UNAUTHORIZED` — credencial Bearer ausente/mal formada o llave desconocida/revocada (respuesta idéntica en ambos casos).
- `403`: `INSUFFICIENT_SCOPE` — a la llave le falta el scope requerido · `PDV_NOT_ALLOWED` — violación del carril X-PDV-ID. Nota de orden: el limitador por llave corre ANTES del gate de scope, así que una petición con scope incorrecto y el bucket agotado responde `429 RATE_LIMITED` (el 429 tiene precedencia sobre este 403).
- `404`: `NOT_FOUND` — ruta desconocida, recurso ajeno/inexistente, o la API pública no está habilitada (respuestas indistinguibles por diseño).
- `429`: `RATE_LIMITED` — bucket de la llave agotado. Espera `Retry-After` s (`details.retry_after_ms` para el hint fino). El limitador corre antes del gate de scope, por lo que un 429 tiene precedencia sobre un 403 `INSUFFICIENT_SCOPE`.
- `500`: `SERVER_ERROR` — falla interna (p. ej. lectura de base de datos). Es transitoria; reintenta con backoff.

---

[API](https://skmtc.dev/enviadores/apis/enviadores-public-api.md) · [All operations](https://skmtc.dev/enviadores/apis/enviadores-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/enviadores/apis/enviadores-public-api/revisions/3633f08c889c?raw)