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

# Retrieve payment accounts status

> Recupere o status das contas de pagamento na sua conta HubSpot. Este endpoint fornece informações sobre a capacidade da conta de processar transações e realizar pagamentos, seu status de adesão, quando ocorreu a última transação (se houver) e os tipos de processadores de pagamento para os quais ela é elegível. Use-o para monitorar e gerenciar o status operacional da sua conta de pagamento.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-09/commerce-paymentsaccounts-v2026-09.json GET /commerce/payment-accounts/2026-09/status
openapi: 3.0.1
info:
  title: Commerce Paymentsaccounts
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
paths:
  /commerce/payment-accounts/2026-09/status:
    get:
      tags:
        - Basic
      summary: >-
        Recupere o status e informações gerais sobre a conta de pagamentos de um
        portal.
      description: >-
        Recupere o status das contas de pagamento na sua conta HubSpot. Este
        endpoint fornece informações sobre a capacidade da conta de processar
        transações e realizar pagamentos, seu status de adesão, quando ocorreu a
        última transação (se houver) e os tipos de processadores de pagamento
        para os quais ela é elegível. Use-o para monitorar e gerenciar o status
        operacional da sua conta de pagamento.
      operationId: get-/commerce/payment-accounts/2026-09/status
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentAccountView'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - cpq.quotes.write
components:
  schemas:
    PaymentAccountView:
      required:
        - canPayout
        - canTransact
        - eligibleProcessorTypes
        - enrollmentState
        - hasTransacted
        - id
        - processorType
      type: object
      properties:
        canPayout:
          type: boolean
          description: Um booleano que indica se a conta é capaz de fazer pagamentos.
        canTransact:
          type: boolean
          description: Um booleano que indica se a conta é capaz de processar transações.
        createdAt:
          type: string
          description: >-
            A data e a hora em que a conta de pagamento foi criada, no formato
            ISO 8601.
          format: date-time
        eligibleProcessorTypes:
          type: array
          description: >-
            Uma matriz de tipos de processador que a conta está qualificada para
            usar. Os valores válidos incluem "HS_PAYMENTS" e "BYO_STRIPE".
          items:
            type: string
            enum:
              - NOT_ENROLLED
              - HS_PAYMENTS
              - BYO_STRIPE
        enrollmentState:
          type: string
          description: >-
            O estado de inscrição atual da conta de pagamento. Os valores
            válidos incluem "NOT_STARTED", "IN_PROGRESS", "IN_UNDERWRITING",
            "ACTIVE", "SUSPENDED", "REJECTED", "OPTED_OUT" e "DISCONNECTED"
          enum:
            - ACTIVE
            - DISCONNECTED
            - IN_PROGRESS
            - IN_UNDERWRITING
            - NOT_STARTED
            - OPTED_OUT
            - REJECTED
            - SUSPENDED
        hasTransacted:
          type: boolean
          description: Um booleano que indica se a conta já processou uma transação.
        id:
          type: string
          description: O portalId da conta de pagamento.
        lastTransactedAt:
          type: string
          description: >-
            A data e a hora da última transação feita com esta conta, no formato
            ISO 8601.
          format: date-time
        processorType:
          type: string
          description: >-
            O tipo de processador de pagamentos associado à conta. Os valores
            válidos incluem 'NOT_ENROLLED', 'HS_PAYMENTS' e 'BYO_STRIPE'.
          enum:
            - BYO_STRIPE
            - HS_PAYMENTS
            - NOT_ENROLLED
        updatedAt:
          type: string
          description: >-
            A data e a hora da última atualização da conta de pagamento, no
            formato ISO 8601.
          format: date-time
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            cpq.quotes.write: ''

````