Skip to main content
GET
Récupérer le statut et les informations générales du compte de paiement d'un portail.

Supported products

Autorisations

Authorization
string
header
requis

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

Réponse

successful operation

canPayout
boolean
requis

Un booléen indiquant si le compte est capable d'effectuer des virements.

canTransact
boolean
requis

Indiquer si le compte est capable de traiter des transactions.

eligibleProcessorTypes
enum<string>[]
requis

Un tableau des types de processeurs que le compte est éligible à utiliser. Les valeurs valides incluent « HS_PAYMENTS » et « BYO_STRIPE ».

Options disponibles:
NOT_ENROLLED,
HS_PAYMENTS,
BYO_STRIPE
enrollmentState
enum<string>
requis

L'état d'inscription actuel du compte de paiement. Les valeurs valides incluent « NOT_STARTED », « IN_PROGRESS », « IN_UNDERWRITING », « ACTIVE », « SUSPENDED », « REJECTED », « OPTED_OUT » et « DISCONNECTED ».

Options disponibles:
ACTIVE,
DISCONNECTED,
IN_PROGRESS,
IN_UNDERWRITING,
NOT_STARTED,
OPTED_OUT,
REJECTED,
SUSPENDED
hasTransacted
boolean
requis

Un booléen indiquant si le compte a déjà traité une transaction.

id
string
requis

L'ID de portail du compte de paiement.

processorType
enum<string>
requis

Le type de prestataire de services de paiement associé au compte. Les valeurs valides incluent « NOT_ENROLLED », « HS_PAYMENTS » et « BYO_STRIPE ».

Options disponibles:
BYO_STRIPE,
HS_PAYMENTS,
NOT_ENROLLED
createdAt
string<date-time>

La date et l'heure de création du compte de paiement, au format ISO 8601.

lastTransactedAt
string<date-time>

La date et l'heure de la dernière transaction effectuée avec ce compte, au format ISO 8601.

updatedAt
string<date-time>

La date et l'heure de la dernière mise à jour du compte de paiement, au format ISO 8601.

Dernière modification le 6 octobre 2026