> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a top-up order

> Status of a wallet top-up order created by `POST /v1/billing/checkout` or `POST /v1/billing/payment-intents` (Pix or card): `pending`, `paid` (wallet credited), `expired` (a Pix not paid within its hour) or `failed`. Read-only: it calls no payment provider. `wallet.topup_paid` is delivered only after the order is completed, so when it arrives this already answers `paid`. Another workspace's id: the same `404 TOPUP_NOT_FOUND`. Owner or Admin (`billing:read`) with an account key or OAuth token.

**Requires a tenant-scoped key** — a workspace key, or an account key with `x-workspace-id`.



## OpenAPI

````yaml openapi.json GET /v1/billing/topups/{id}
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/billing/topups/{id}:
    get:
      tags:
        - Billing
      summary: Get a top-up order
      description: >-
        Status of a wallet top-up order created by `POST /v1/billing/checkout`
        or `POST /v1/billing/payment-intents` (Pix or card): `pending`, `paid`
        (wallet credited), `expired` (a Pix not paid within its hour) or
        `failed`. Read-only: it calls no payment provider. `wallet.topup_paid`
        is delivered only after the order is completed, so when it arrives this
        already answers `paid`. Another workspace's id: the same `404
        TOPUP_NOT_FOUND`. Owner or Admin (`billing:read`) with an account key or
        OAuth token.


        **Requires a tenant-scoped key** — a workspace key, or an account key
        with `x-workspace-id`.
      operationId: get_billing_topups_id
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: The `orderId` returned when the top-up was created.
          example: cmh2b4k1n0001to8example2p
        - name: x-workspace-id
          in: header
          required: false
          schema:
            type: string
          description: >-
            Only with an account key (`ps_account_`): the workspace to act on,
            from `GET /v1/workspaces`. Without it an account key gets `400
            WORKSPACE_ID_REQUIRED`.
          example: cmh2a9z8y0002ws8example1q
      responses:
        '200':
          description: The order
          content:
            application/json:
              example:
                topup:
                  id: cmh2b4k1n0001to8example2p
                  status: paid
                  amount: 100
                  currency: BRL
                  method: pix
                  provider: PAGUE_DEV
                  createdAt: '2026-10-28T10:15:00.000Z'
                  paidAt: '2026-10-28T10:17:42.000Z'
                  expiresAt: '2026-10-28T11:15:00.000Z'
        '401':
          description: Missing, invalid or revoked API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Invalid API key
        '403':
          description: >-
            Number-scoped key (`NUMBER_SCOPE_NOT_ALLOWED`), the user's role does
            not allow it (`PERMISSION_DENIED`), or an account key outside its
            workspaces (`WORKSPACE_MEMBERSHIP_REQUIRED`)
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: This endpoint requires a tenant-scoped API key
                code: NUMBER_SCOPE_NOT_ALLOWED
        '404':
          description: No top-up order with that id in this workspace
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Top-up order not found | Pedido de recarga não encontrado
                code: TOPUP_NOT_FOUND
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.