Pular para o conteúdo principal
GET
Recupere o status e informações gerais sobre a conta de pagamentos de um portal.

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Resposta

successful operation

canPayout
boolean
obrigatório

Um booleano que indica se a conta é capaz de fazer pagamentos.

canTransact
boolean
obrigatório

Um booleano que indica se a conta é capaz de processar transações.

eligibleProcessorTypes
enum<string>[]
obrigatório

Uma matriz de tipos de processador que a conta está qualificada para usar. Os valores válidos incluem "HS_PAYMENTS" e "BYO_STRIPE".

Opções disponíveis:
NOT_ENROLLED,
HS_PAYMENTS,
BYO_STRIPE
enrollmentState
enum<string>
obrigatório

O estado de inscrição atual da conta de pagamento. Os valores válidos incluem "NOT_STARTED", "IN_PROGRESS", "IN_UNDERWRITING", "ACTIVE", "SUSPENDED", "REJECTED", "OPTED_OUT" e "DISCONNECTED"

Opções disponíveis:
ACTIVE,
DISCONNECTED,
IN_PROGRESS,
IN_UNDERWRITING,
NOT_STARTED,
OPTED_OUT,
REJECTED,
SUSPENDED
hasTransacted
boolean
obrigatório

Um booleano que indica se a conta já processou uma transação.

id
string
obrigatório

O portalId da conta de pagamento.

processorType
enum<string>
obrigatório

O tipo de processador de pagamentos associado à conta. Os valores válidos incluem 'NOT_ENROLLED', 'HS_PAYMENTS' e 'BYO_STRIPE'.

Opções disponíveis:
BYO_STRIPE,
HS_PAYMENTS,
NOT_ENROLLED
createdAt
string<date-time>

A data e a hora em que a conta de pagamento foi criada, no formato ISO 8601.

lastTransactedAt
string<date-time>

A data e a hora da última transação feita com esta conta, no formato ISO 8601.

updatedAt
string<date-time>

A data e a hora da última atualização da conta de pagamento, no formato ISO 8601.

Última modificação em 6 de outubro de 2026