> ## Documentation Index > Fetch the complete documentation index at: https://docs.spenza.com/llms.txt > Use this file to discover all available pages before exploring further. # Add prepaid credit > Create a hosted Stripe checkout link to add prepaid credit. `amount` is in the currency's **major unit** (e.g. `100` = $100.00). The returned `transactionId` moves to `COMPLETED`/`FAILED` once Stripe's checkout webhook fires — poll `statusEndpoint`, not this call, for the outcome. ## OpenAPI ````yaml /openapi.yaml post /api/v1.1/top-up openapi: 3.1.0 info: title: Spenza Partner API version: 3.0.0 summary: >- Partner API for SIMs, eSIMs, plans, billing, users, groups and numbers — v1.1 surface. description: > The **Spenza Partner API** lets you manage SIMs, eSIMs, plans, subscriptions, billing, users, phone numbers, teams and device/SIM/user groups programmatically. All endpoints follow one consistent standard: - **Auth** — exchange your API `key` + `secret` for a bearer token, then send `Authorization: Bearer ` on every request. - **Envelopes** — success responses are `{ success, data, meta? }`; errors are `{ success: false, error: { code, message, details? } }`. - **Pagination** — list endpoints accept `page` (1-indexed) and `pageSize` (max 100); totals are returned in `meta`. - **Idempotency** — many write endpoints honor an optional `Idempotency-Key` request header so a retried call replays the original result instead of repeating the side effect. - **Async operations** — a handful of endpoints (eSIM provisioning, port-in, the `/api/v3/...` purchase variants, top-up) return `202` (`201` for top-up) with a `transactionId` + `statusEndpoint` instead of the finished resource. Poll `GET /api/v3/transactions/{transactionId}` (no auth required) until the transaction reaches a terminal status. One resource — **port-in submission** — is a documented exception: it lives at `POST /api/v3/port-in`, requires an Admin-tier account role rather than just a valid bearer token, and is **not** on the standard envelope (see that operation's description for its exact response shape). contact: name: Spenza API Support email: support@spenza.com url: https://spenza.com license: name: Proprietary url: https://spenza.com/terms x-logo: url: https://spenza.com/logo.png altText: Spenza servers: - url: https://api.spenza.com description: Production security: - bearerAuth: [] tags: - name: Authentication description: Exchange API credentials for a bearer token. - name: SIMs description: List, inspect, assign and manage SIMs. - name: Subscriptions description: Plan subscriptions attached to SIMs. - name: Plans & Catalog description: Purchasable plans and SIM products. - name: eSIM description: Provision eSIMs and fetch activation QR / install status. - name: Billing description: Invoices, credit balance and top-ups. - name: Users description: End users (employees) on your account that SIMs/devices are assigned to. - name: Orders & Transactions description: Order history and financial transactions. - name: Numbers & Port-in description: Check port-in eligibility and port existing numbers into Spenza. - name: Messaging description: Send outbound SMS from a provisioned number. - name: Webhooks description: Register endpoints for operator SMS/voice events and inspect deliveries. - name: Notifications description: In-account notifications and delivery preferences. - name: Device Groups description: Organize devices into named groups with spend/data limits. - name: SIM Groups description: Organize SIMs into named groups with spend/data limits. - name: User Groups description: Organize users (departments) into named groups with spend/data limits. - name: Devices description: The device catalog (phones/tablets) and their assignment to users. - name: Team Members description: Admins who manage your Spenza account (distinct from Users/end-users). - name: Async Status description: Universal status poll for any asynchronous (v3) operation. paths: /api/v1.1/top-up: post: tags: - Billing summary: Add prepaid credit description: | Create a hosted Stripe checkout link to add prepaid credit. `amount` is in the currency's **major unit** (e.g. `100` = $100.00). The returned `transactionId` moves to `COMPLETED`/`FAILED` once Stripe's checkout webhook fires — poll `statusEndpoint`, not this call, for the outcome. operationId: topUp parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: type: object required: - amount - currency properties: amount: type: number description: Major currency unit, must be > 0. example: 100 currency: type: string description: ISO-4217 3-letter code, case-insensitive. example: usd returnUrl: type: string description: >- Used as both the success and cancel URL. Defaults to https://app.spenza.com/account. responses: '201': description: Checkout link created. content: application/json: example: success: true data: checkoutUrl: >- https://checkout.stripe.com/c/pay/cs_test_a1B2c3D4e5F6G7H8I9J0 transactionId: 64f1a2b3c4d5e6f7a8b9c0d1 statusEndpoint: /api/v3/transactions/64f1a2b3c4d5e6f7a8b9c0d1 '400': description: > Missing/invalid amount or currency, or account has no Stripe customer yet. Note: the app-wide validation pipe validates `amount`/`currency`/`returnUrl` before this handler runs, so a present-but-invalid value actually surfaces the auto-generated, joined class-validator message shown in the `invalid` example below — not a friendlier hand-written string. The `missing` example only fires when `amount`/`currency` are absent entirely. content: application/json: examples: missing: value: success: false error: code: MISSING_FIELDS message: Please enter an amount and currency to add credit. invalid: value: success: false error: code: VALIDATION_ERROR message: >- amount must be greater than 0; currency must be a supported currency code '409': description: >- The `Idempotency-Key` was reused with a different request, or a replay was received while the original request is still in flight. content: application/json: examples: idempotencyReused: value: success: false error: code: IDEMPOTENCY_KEY_REUSED message: >- This request was already submitted with different details — please use a new idempotency key. inFlight: value: success: false error: code: CONFLICT message: This request is already being processed. '429': $ref: '#/components/responses/RateLimited' components: parameters: IdempotencyKey: name: Idempotency-Key in: header required: false description: > Any string unique to this logical request. On a retry with the same key and the same request body, the original response is replayed verbatim (with an `Idempotency-Replayed: true` response header) instead of the action repeating. Reusing the key with a **different** body or on a different route returns `409 IDEMPOTENCY_KEY_REUSED`. A replay attempted while the original call is still in flight returns `409 CONFLICT`. Optional — omit it and the endpoint behaves exactly as it would otherwise. schema: type: string example: a1b2c3d4-idem-key-001 responses: RateLimited: description: > Rate limit exceeded for this endpoint (or the account-wide default of 120 req/min). Only `Retry-After` is present on this response — the `X-RateLimit-*` headers below are sent on successful (non-429) requests, not on the 429 itself. headers: Retry-After: description: Seconds until you can retry. schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' example: success: false error: code: RATE_LIMITED message: 'ThrottlerException: Too Many Requests' schemas: ErrorEnvelope: type: object required: - success - error properties: success: type: boolean example: false error: type: object required: - code - message properties: code: type: string example: SIM_NOT_FOUND message: type: string example: We couldn't find a SIM with that ICCID on your account. details: description: >- Present on some 4xx errors (for example a list of missing fields). Always absent on 5xx. type: object securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: Bearer token obtained from `POST /api/v1.1/auth/token`. ````