organization

Listar las cuentas de la organización

Changed on

Las cuentas que alcanza una llave de organización, para convertir el account_id de cada movimiento en la sucursal que le corresponde. Requiere una llave de organización.

get/organization/accounts

Request

Query parameters

pageinteger

Página a devolver. La respuesta trae los encabezados link, current-page, total-pages y total-count.

itemsinteger

Elementos por página.

Response

Cuentas de la organización

idstring

ID único de la cuenta conectada

statusstring

Estado de la cuenta

namestring

Nombre comercial de la cuenta

account_type'business' | 'individual' | 'non_profit'

Tipo de cuenta de negocio

created_atstring date-time

Fecha de creación

creator_namestring

Nombre del usuario creador

creator_emailstring email

Email del usuario creador

tax_idstring nullable

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

tax_namestring nullable

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

withdrawals_schedule'daily' | 'manual' | 'instant'

Frecuencia configurada para retiros

onboarding_completedboolean

Indica si la cuenta completó onboarding

Changes

    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to array for status

    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API