Skip to main content
POST
Crea una cuenta (ACC-001)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required
Example:

"BBVA Nómina"

accountTypeId
string

Tipo de cuenta del catálogo del workspace (ACC-012). Requerido salvo que envíes type.

type
enum<string>

Atajo: clave del tipo sembrado (checking, savings, …). Se resuelve al tipo del workspace; alternativa a accountTypeId.

Available options:
checking,
savings,
credit_card,
cash,
investment,
loan,
real_estate,
other
bank
string
Example:

"BBVA"

initialBalance
string

Saldo inicial. Negativo sólo para loan y credit_card (pasivos).

Example:

"1500.00"

currency
string

Moneda de la cuenta (ISO 4217). Default = moneda base del workspace (09).

Example:

"USD"

fxMode
enum<string>

auto = tasa diaria; fixed = fixedRate. Solo aplica si la moneda ≠ base (09).

Available options:
auto,
fixed
fixedRate
string

Tasa fija cuenta→base (solo fxMode=fixed).

Example:

"17.50000000"

apy
string

Tasa anual (APY) en %; la usa Forecast (R2).

Example:

"7.5000"

alertThreshold
string

Umbral de alerta de saldo bajo (R2).

Example:

"500.00"

Response

200 - application/json
id
string
required
name
string
required
type
object
required

Tipo del catálogo (ACC-012).

bank
string | null
required
currency
string
required
Example:

"MXN"

balance
string
required
Example:

"1500.00"

fxMode
enum<string>
required
Available options:
auto,
fixed
fixedRate
string | null
required
Example:

"17.50000000"

apy
string | null
required
alertThreshold
string | null
required
status
enum<string>
required
Available options:
active,
archived,
closed
createdAt
string
required
updatedAt
string
required