Sign in
Basic

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

Retrieve the status of payment accounts in your HubSpot account. This endpoint provides information about the account's ability to transact and payout, its enrollment state, when or if it has transacted last, and the types of payment processors it is eligible for. Use this to monitor and manage your payment account's operational status.

get/commerce/payment-accounts/2027-03-beta/status

Request

  • Base URL: https://api.hubapi.com
  • URL: https://api.hubapi.com/commerce/payment-accounts/2027-03-beta/status
  • Auth: OAuth 2 (authorization code, authorization URL https://app.hubspot.com/oauth/authorize, token URL https://api.hubapi.com/oauth/v1/token, scopes: cpq.quotes.write)

Response

successful operation

canPayoutboolean required

A boolean indicating whether the account is capable of making payouts.

canTransactboolean required

A boolean indicating whether the account is capable of processing transactions.

createdAtstring date-time

The date and time when the payment account was created, in ISO 8601 format.

eligibleProcessorTypesstring[] required

An array of processor types that the account is eligible to use. Valid values include 'HS_PAYMENTS', and 'BYO_STRIPE'.

enrollmentState'ACTIVE' | 'DISCONNECTED' | 'IN_PROGRESS' | 'IN_UNDERWRITING' | 'NOT_STARTED' | 'OPTED_OUT' | 'REJECTED' | 'SUSPENDED' required

The current enrollment state of the payment account. Valid values include 'NOT_STARTED', 'IN_PROGRESS', 'IN_UNDERWRITING', 'ACTIVE', 'SUSPENDED', 'REJECTED', 'OPTED_OUT', and 'DISCONNECTED'.

hasTransactedboolean required

A boolean indicating whether the account has ever processed a transaction.

idstring required

The portalId for the payment account.

lastTransactedAtstring date-time

The date and time of the last transaction made with this account, in ISO 8601 format.

processorType'BYO_STRIPE' | 'HS_PAYMENTS' | 'NOT_ENROLLED' required

The type of payment processor associated with the account. Valid values include 'NOT_ENROLLED', 'HS_PAYMENTS', and 'BYO_STRIPE'.

updatedAtstring date-time

The date and time when the payment account was last updated, in ISO 8601 format.

Changes

No recorded changes to this operation across all 5 revisions of this API.