Skip to main content
GET
Retrieve status and general information about a portal's payments account.

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Response

successful operation

canPayout
boolean
required

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

canTransact
boolean
required

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

eligibleProcessorTypes
enum<string>[]
required

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

Available options:
NOT_ENROLLED,
HS_PAYMENTS,
BYO_STRIPE
enrollmentState
enum<string>
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'.

Available options:
ACTIVE,
DISCONNECTED,
IN_PROGRESS,
IN_UNDERWRITING,
NOT_STARTED,
OPTED_OUT,
REJECTED,
SUSPENDED
hasTransacted
boolean
required

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

id
string
required

The portalId for the payment account.

processorType
enum<string>
required

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

Available options:
BYO_STRIPE,
HS_PAYMENTS,
NOT_ENROLLED
createdAt
string<date-time>

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

lastTransactedAt
string<date-time>

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

updatedAt
string<date-time>

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

Last modified on September 9, 2026