Skip to content

HubSpot: Payments accounts schemas

1 HubSpot schema with complete fields and constraints.

โ† Payments accounts operations ยท All schemas

Retrieve status and general information about a portal's payments account โ€” response body

FieldTypePresenceDescription and constraints
$objectRoot
canPayoutbooleanRequired within parentA boolean indicating whether the account is capable of making payouts.
canTransactbooleanRequired within parentA boolean indicating whether the account is capable of processing transactions.
createdAtstringOptionalThe date and time when the payment account was created, in ISO 8601 format.
Format: date-time
eligibleProcessorTypesarrayRequired within parentAn array of processor types that the account is eligible to use. Valid values include 'HS_PAYMENTS', and 'BYO_STRIPE'.
eligibleProcessorTypes[]stringEach itemKnown values: NOT_ENROLLED, HS_PAYMENTS, BYO_STRIPE
enrollmentStatestringRequired within parentThe 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
hasTransactedbooleanRequired within parentA boolean indicating whether the account has ever processed a transaction.
idstringRequired within parentThe portalId for the payment account.
lastTransactedAtstringOptionalThe date and time of the last transaction made with this account, in ISO 8601 format.
Format: date-time
processorTypestringRequired within parentThe 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
updatedAtstringOptionalThe date and time when the payment account was last updated, in ISO 8601 format.
Format: date-time

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.