> ## 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.

# Consultar um pedido de recarga

> Status de um pedido de recarga criado por `POST /v1/billing/checkout` ou `POST /v1/billing/payment-intents` (Pix ou cartão): `pending`, `paid` (carteira creditada), `expired` (Pix não pago dentro da hora) ou `failed`. Só leitura: não chama nenhum provedor de pagamento. O `wallet.topup_paid` só é entregue depois que o pedido é concluído; quando ele chega, este endpoint já responde `paid`. Id de outro workspace: o mesmo `404 TOPUP_NOT_FOUND`. Proprietário ou Admin (`billing:read`) com chave de conta ou token OAuth.

**Requer uma chave com escopo de tenant** — uma chave de workspace, ou uma chave de conta com `x-workspace-id`.



## OpenAPI

````yaml openapi.pt.json GET /v1/billing/topups/{id}
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `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: Consultar um pedido de recarga
      description: >-
        Status de um pedido de recarga criado por `POST /v1/billing/checkout` ou
        `POST /v1/billing/payment-intents` (Pix ou cartão): `pending`, `paid`
        (carteira creditada), `expired` (Pix não pago dentro da hora) ou
        `failed`. Só leitura: não chama nenhum provedor de pagamento. O
        `wallet.topup_paid` só é entregue depois que o pedido é concluído;
        quando ele chega, este endpoint já responde `paid`. Id de outro
        workspace: o mesmo `404 TOPUP_NOT_FOUND`. Proprietário ou Admin
        (`billing:read`) com chave de conta ou token OAuth.


        **Requer uma chave com escopo de tenant** — uma chave de workspace, ou
        uma chave de conta com `x-workspace-id`.
      operationId: get_billing_topups_id
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: O `orderId` devolvido na criação da recarga.
          example: cmh2b4k1n0001to8example2p
        - name: x-workspace-id
          in: header
          required: false
          schema:
            type: string
          description: >-
            Só com chave de conta (`ps_account_`): o workspace em que agir,
            obtido em `GET /v1/workspaces`. Sem ele, uma chave de conta recebe
            `400 WORKSPACE_ID_REQUIRED`.
          example: cmh2a9z8y0002ws8example1q
      responses:
        '200':
          description: O pedido
          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: Chave de API ausente, inválida ou revogada
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Invalid API key
        '403':
          description: >-
            Chave com escopo de número (`NUMBER_SCOPE_NOT_ALLOWED`), papel do
            usuário sem permissão (`PERMISSION_DENIED`) ou chave de conta fora
            dos seus 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: Nenhum pedido de recarga com esse id neste 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: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````

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