Retrieve payment accounts status
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.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Response
successful operation
A boolean indicating whether the account is capable of making payouts.
A boolean indicating whether the account is capable of processing transactions.
An array of processor types that the account is eligible to use. Valid values include 'HS_PAYMENTS', and 'BYO_STRIPE'.
NOT_ENROLLED, HS_PAYMENTS, BYO_STRIPE The current enrollment state of the payment account. Valid values include 'NOT_STARTED', 'IN_PROGRESS', 'IN_UNDERWRITING', 'ACTIVE', 'SUSPENDED', 'REJECTED', 'OPTED_OUT', and 'DISCONNECTED'.
ACTIVE, DISCONNECTED, IN_PROGRESS, IN_UNDERWRITING, NOT_STARTED, OPTED_OUT, REJECTED, SUSPENDED A boolean indicating whether the account has ever processed a transaction.
The portalId for the payment account.
The type of payment processor associated with the account. Valid values include 'NOT_ENROLLED', 'HS_PAYMENTS', and 'BYO_STRIPE'.
BYO_STRIPE, HS_PAYMENTS, NOT_ENROLLED The date and time when the payment account was created, in ISO 8601 format.
The date and time of the last transaction made with this account, in ISO 8601 format.
The date and time when the payment account was last updated, in ISO 8601 format.