---
title: "Start a balance top-up"
method: POST
path: "/balance/topup"
tags: ["Queue & balance", "Human only"]
---

# Start a balance top-up

`POST /balance/topup`

## Request

- Base URL: `https://gtmswag.com/api/v1`
- URL: `https://gtmswag.com/api/v1/balance/topup`
- Auth: API key in cookie `gtm_session`

Human only: A signed-in owner or admin does this in the browser at gtmswag.com. API keys and OAuth connections receive 403 HUMAN_APPROVAL_REQUIRED with a `url` to hand to that person. Hand `topUpUrl` from `GET /balance` to them. Returns the Stripe payment URL a person opens; the credit lands once payment completes.

## Request body

- object
  - `cents` integer, required: Top-up amount in US cents, 2500 to 2000000.
  - `idempotencyKey` string, required: Same key for identical retries only.

## Response `200`

Success: `{"data": TopUpSession}`.

- TopUpSessionResponse: The success body: `{"data": TopUpSession}`.
  - `data` TopUpSession, required: The Stripe payment page a person opens to add funds.
    - `url` string, required
    - `sessionId` string, required

## Other responses

- `400`: Bad request: `VALIDATION_ERROR`, `INVALID_JSON`. Each example says when.
- `401`: Not authenticated: `AUTH_REQUIRED`. no credentials, or an OAuth token on a route that only takes workspace keys; the key is malformed, unknown or revoked.
- `403`: Forbidden: `HUMAN_APPROVAL_REQUIRED`, `TEAM_MANAGER_REQUIRED`. Each example says when.
- `413`: Request too large: `INVALID_REQUEST`. the body exceeds 1 MiB.
- `415`: Unsupported media type: `INVALID_REQUEST`. a write with a body that is not `Content-Type: application/json` (a key request with no body needs no Content-Type).
- `429`: Too many requests: `RATE_LIMIT`. more than 240 requests in the current minute for this workspace (REST and MCP share the limit); wait `retryAfterMs`.
- `502`: Upstream error: `PAYMENT_UNAVAILABLE`. Each example says when.
- `503`: Unavailable: `STRIPE_UNAVAILABLE`. Each example says when.
- `default`: Any other refusal or failure, such as 403 CSRF (a cross-origin `Origin` header), 403 HTTPS_REQUIRED or 500 INTERNAL_ERROR, with what to do next.

---

[API](https://skmtc.dev/gtmswag/apis/gtm-swag-api.md) · [All operations](https://skmtc.dev/gtmswag/apis/gtm-swag-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gtmswag/apis/gtm-swag-api/revisions/9ff86fa99afe?raw)