Skip to navigation
Referencia APIConnected Accounts

Obtener cuenta conectada

Obtén los detalles de una cuenta conectada a tu cuenta.

Authentication

X-SECRET-KEYstring

Tu clave secreta de API.

Una llave de cuenta (sk_live_..., sk_test_...) opera sobre su propia cuenta y, con X-ACCOUNT-ID, sobre sus cuentas conectadas.

La llave también fija el ambiente: una sk_test_ solo lista y resuelve objetos de prueba (live_mode: false) y una sk_live_ solo objetos reales. Un ID del otro ambiente responde 404 (401 en /customers).

Una llave de organización (sk_org_live_..., sk_org_test_...) alcanza todas las cuentas de una organización y solo sirve para leer: saldos, movimientos y reportes. Para operar sobre una cuenta debe nombrarla con X-ACCOUNT-ID; omitirlo en una lectura devuelve todas las cuentas de la organización. Cualquier otro endpoint responde 403 con code: organization_key_unsupported.

Path parameters

idstringRequired
ID de la cuenta conectada

Response

Detalles de la cuenta conectada
idstringOptional

ID único de la cuenta conectada

statusstringOptional
Estado de la cuenta
namestringOptional
Nombre comercial de la cuenta
account_typeenumOptional
Tipo de cuenta de negocio
Allowed values:
created_atdatetimeOptional

Fecha de creación

creator_namestringOptional
Nombre del usuario creador
creator_emailstringOptionalformat: "email"
Email del usuario creador
tax_idstring or nullOptional

NIT extraído del RTU; si no está disponible, se conserva el ID fiscal previamente guardado en la cuenta.

tax_namestring or nullOptional

Razón social extraída del RTU; si no está disponible, se conserva el nombre fiscal previamente guardado en la cuenta.

withdrawals_scheduleenum or nullOptional
Frecuencia configurada para retiros
Allowed values:
onboarding_completedbooleanOptional

Indica si la cuenta completó onboarding

Errors

404
Not Found Error