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

# Status do Portal Wallet

> Consulta o estado do login do operador na subconta.

<RequestExample>
  ```bash cURL — uma subconta theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/subaccount/portal/status?externalReference=loja-parceiro-a' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```

  ```bash cURL — todas as subcontas theme={null}
  curl -X GET 'https://api.goatpay.com.br/v1/subaccount/portal/status' \
    -H 'X-API-Key: gp_live_SUA_CHAVE'
  ```
</RequestExample>

<ResponseExample>
  ```json Success — uma subconta theme={null}
  {
    "success": true,
    "message": "Status do portal",
    "data": {
      "subaccountId": "clx_subconta",
      "subaccountName": "Loja Parceiro",
      "portal": {
        "state": "active",
        "email": "operador@empresa.com",
        "emailVerified": true,
        "twoFactorEnabled": false,
        "lastLoginAt": "2026-06-08T14:22:00.000Z"
      }
    },
    "requestId": "req_abc123"
  }
  ```
</ResponseExample>

<ParamField query="id" type="string">
  ID da subconta. Informe `id` ou `externalReference`, ou omita ambos para listar todas.
</ParamField>

<ParamField query="externalReference" type="string">
  Referência externa da subconta.
</ParamField>

<Note>
  Permissão da API key: `subaccount/portal/get`. Estados possíveis: `none`, `active`, `disabled`, `pending_password`, `invite_pending`, `pending_verification` (legado).
</Note>


## OpenAPI

````yaml GET /subaccount/portal/status
openapi: 3.1.0
info:
  title: GoatPay API
  description: >
    API pública merchant da GoatPay. Autenticação via header `X-API-Key:
    gp_live_...`.

    Respostas de sucesso usam o envelope `{ success, message, data, requestId
    }`.

    Campos internos (`accountId`, `metadata`, histórico de entregas de webhook,
    etc.) não são expostos.

    `providerTransactionId` aparece como `referenceId`; `providerInfractionId`
    como `infractionId`.

    Rate limit global: 100 requisições por minuto por API key (HTTP 429). Sem
    chave, limite por IP.
  version: 1.0.0
servers:
  - url: https://api.goatpay.com.br/v1
    description: Produção
security:
  - apiKeyAuth: []
tags:
  - name: pix
    description: >-
      Cobranças PIX (receber), reembolsos de depósito recebido e transferências
      PIX (enviar). Alias legado em payouts/* para envios.
  - name: transfer-internal
    description: Transferências entre contas GoatPay
  - name: transfer-scheduled
    description: Transferências programadas (agendar, repetir ou por saldo)
  - name: crypto
    description: Depósitos e transferências em criptomoeda
  - name: billings
    description: >-
      Cobranças avulsas (pagamento único) — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: subscriptions
    description: >-
      Assinaturas recorrentes com ciclo fixo — boleto, cartão ou PIX na Conta
      Padrão (PF ou PJ)
  - name: account
    description: Saldo e extrato
  - name: subaccount
    description: Subcontas merchant (carteiras lógicas sob a conta principal)
  - name: meds
    description: Disputas MED
  - name: webhooks
    description: Endpoints de webhook de saída
  - name: payouts
    description: Alias de transfer-pix para saques PIX
  - name: customers
    description: Clientes da loja (CRM)
  - name: products
    description: Produtos e entregas digitais
  - name: coupons
    description: Cupons de desconto para links
  - name: payment-links
    description: Links de pagamento e checkout hospedado
paths:
  /subaccount/portal/status:
    get:
      tags:
        - subaccount
      summary: Status do Portal Wallet
      description: >-
        Sem query params, lista todas as subcontas. Com id ou externalReference,
        retorna uma subconta.
      operationId: getSubaccountPortalStatus
      parameters:
        - name: id
          in: query
          schema:
            type: string
        - name: externalReference
          in: query
          schema:
            type: string
      responses:
        '200':
          $ref: '#/components/responses/SubaccountPortalStatusSuccess'
components:
  responses:
    SubaccountPortalStatusSuccess:
      description: Status do Portal Wallet.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/SuccessEnvelope'
          examples:
            default:
              value:
                success: true
                message: Status do portal
                data:
                  subaccountId: clx_subconta
                  subaccountName: Loja Parceiro
                  portal:
                    state: active
                    email: operador@empresa.com
                    emailVerified: true
                    twoFactorEnabled: false
                    lastLoginAt: '2026-06-08T14:22:00.000Z'
                requestId: req_abc123
  schemas:
    SuccessEnvelope:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Operação concluída com sucesso
        data:
          type: object
          additionalProperties: true
        requestId:
          type: string
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave `gp_live_...` criada em Integrações → Chaves de API no dashboard.

````