Crear una cuenta bancaria

POST

https://app.recurrente.com/api/bank_accounts

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.

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.

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.

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

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

currencyenumOptional

Moneda de la cuenta bancaria

account_typeenum or nullOptional

Tipo de cuenta bancaria

is_preferredbooleanOptional

Indica si es la cuenta preferida para su moneda

ownership_typeenumOptional

Tipo de cuenta bancaria

Errors

400

Bad Request Error

$	curl -X POST https://app.recurrente.com/api/bank_accounts \
>	-H "X-SECRET-KEY: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"holder_name": "Acme, S.A.",
>	"number": "1234567890",
>	"bank_name": "Banco Industrial",
>	"currency": "GTQ",
>	"account_type": "checking"
>	}'

1	{
2	"id": "ba_lmgbvesmihkqzma3",
3	"bank_name": "Banco Industrial",
4	"holder_name": "Acme Restaurant, S.A.",
5	"created_at": "2024-01-15T09:30:00Z",
6	"status": "active",
7	"currency": "GTQ",
8	"account_type": "checking",
9	"is_preferred": true,
10	"ownership_type": "external"
11	}