Sign in
bankAccounts

Crear una cuenta bancaria

Registra una cuenta bancaria externa como destino de retiro. Usa GET /banks para los valores válidos de bank_name. Las cuentas son inmutables salvo is_preferred — archiva y crea una nueva para cambiar otros datos.

post/bank_accounts

Headers

X-SECRET-KEYstring required

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.

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.

Request body

holder_namestring required
numberstring required
bank_namestring required
currency'GTQ' | 'USD' required
account_type'checking' | 'savings' required
is_preferredboolean

Response

Cuenta bancaria creada

idstring

ID único de la cuenta bancaria

bank_namestring nullable

Nombre del banco

holder_namestring

Nombre del titular

created_atstring date-time

Fecha de creación

status'active' | 'archived'

Estado de la cuenta bancaria

currency'GTQ' | 'USD'

Moneda de la cuenta bancaria

account_type'checking' | 'savings'

Tipo de cuenta bancaria

is_preferredboolean

Indica si es la cuenta preferida para su moneda

ownership_type'external' | 'virtual'

Tipo de cuenta bancaria

Changes

No recorded changes to this endpoint across all 1 revision of this API.