Skip to navigation

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.

Se aplican las mismas validaciones que al agregar una cuenta desde la app: primero el formato por banco, moneda y tipo; luego se consulta al banco mediante Nexa cuando está disponible. Un titular confirmado reemplaza holder_name. Si el banco rechaza la cuenta, responde 400. Si no se puede confirmar, el nombre enviado permite guardarla sin confirmar. Sandbox no consulta al banco.

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.

Request

This endpoint expects an object.
holder_namestringRequired
numberstringRequired
bank_namestringRequired
currencyenumRequired
Allowed values:
account_typeenumRequired
Allowed values:
is_preferredbooleanOptional

Response

Cuenta bancaria creada
idstringOptional

ID único de la cuenta bancaria

bank_namestring or nullOptional
Nombre del banco
holder_namestringOptional
Nombre del titular
created_atdatetimeOptional

Fecha de creación

statusenumOptional
Estado de la cuenta bancaria
Allowed values:
currencyenumOptional
Moneda de la cuenta bancaria
Allowed values:
account_typeenum or nullOptional
Tipo de cuenta bancaria
Allowed values:
is_preferredbooleanOptional
Indica si es la cuenta preferida para su moneda
ownership_typeenumOptional
Tipo de cuenta bancaria
Allowed values:

Errors

400
Bad Request Error