HubSpot: Retrieve status and general information about a portal's payments account

← Payments accounts operations · Get started

Operation hubspot.payments_accounts_get_payment_account

Provider route: GET /commerce/payment-accounts/2026-09/status. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["paymentsAccounts"]["getPaymentAccount"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.paymentsAccounts.getPaymentAccount(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.payments_accounts.get_payment_account(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Retrieve status and general information about a portal’s payments account — response body

Referenced models: Retrieve status and general information about a portal’s payments account — response body

Schemas

Retrieve status and general information about a portal's payments account — response body

Field	Type	Presence	Description and constraints
$	object	Root
canPayout	boolean	Required within parent	A boolean indicating whether the account is capable of making payouts.
canTransact	boolean	Required within parent	A boolean indicating whether the account is capable of processing transactions.
createdAt	string	Optional	The date and time when the payment account was created, in ISO 8601 format. Format: date-time
eligibleProcessorTypes	array	Required within parent	An array of processor types that the account is eligible to use. Valid values include 'HS_PAYMENTS', and 'BYO_STRIPE'.
eligibleProcessorTypes[]	string	Each item	Known values: NOT_ENROLLED, HS_PAYMENTS, BYO_STRIPE
enrollmentState	string	Required within parent	The current enrollment state of the payment account. Valid values include 'NOT_STARTED', 'IN_PROGRESS', 'IN_UNDERWRITING', 'ACTIVE', 'SUSPENDED', 'REJECTED', 'OPTED_OUT', and 'DISCONNECTED'. Known values: ACTIVE, DISCONNECTED, IN_PROGRESS, IN_UNDERWRITING, NOT_STARTED, OPTED_OUT, REJECTED, SUSPENDED
hasTransacted	boolean	Required within parent	A boolean indicating whether the account has ever processed a transaction.
id	string	Required within parent	The portalId for the payment account.
lastTransactedAt	string	Optional	The date and time of the last transaction made with this account, in ISO 8601 format. Format: date-time
processorType	string	Required within parent	The type of payment processor associated with the account. Valid values include 'NOT_ENROLLED', 'HS_PAYMENTS', and 'BYO_STRIPE'. Known values: BYO_STRIPE, HS_PAYMENTS, NOT_ENROLLED
updatedAt	string	Optional	The date and time when the payment account was last updated, in ISO 8601 format. Format: date-time

Policy, approvals and errors

SDK function policy ID: hubspot.payments_accounts_get_payment_account. Catalog operation: payments_accounts_get_payment_account. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["commerce.payment_accounts.read"]

Official provider source