Sign in
serviceTabs

Abrir una cuenta

Abre una cuenta para un cliente. Identifica al cliente con customer_id, o con phone y display_name para crearlo si no existe.

El compromiso de apertura se infiere de lo que envíes: items abre la cuenta ya con esos consumos, estimated_amount la abre con un monto estimado sin items, y si no envías ninguno la cuenta queda vacía y le agregas items después.

La estrategia de cobro es siempre card_on_file: al cerrar se cobra la tarjeta guardada del cliente (o le entregas un link de pago). La preautorización con hold solo se puede activar desde el dashboard, porque requiere una autorización real del procesador.

Usa un Idempotency-Key único por cuenta abierta.

post/service_tabs

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

customer_idstring

ID del cliente. Si lo omites, se resuelve o crea con phone y display_name.

display_namestring

Nombre con el que identificas la cuenta (mesa, cliente, cuarto)

phonestring

Teléfono del cliente

currencystring

Moneda de la cuenta. Por defecto, la moneda principal de tu cuenta.

estimated_amountstring

Monto estimado de consumo, en unidades de la moneda (no centavos)

payment_method_idstring

Método de pago guardado del cliente que se cobrará al cerrar

Response

Cuenta abierta

idstring

ID de la cuenta abierta

status'open' | 'closing' | 'paid' | 'voided' | 'abandoned'

Estado de la cuenta. open acepta items; closing ya está cerrada y espera el pago; paid se cobró; voided se anuló sin cobrar; abandoned se dejó vencer.

display_namestring

Nombre con el que el comercio identifica la cuenta (mesa, cliente, cuarto)

phonestring nullable

Teléfono del cliente al momento de abrir la cuenta

customer_idstring

ID del cliente dueño de la cuenta

currencystring

Moneda de la cuenta

total_in_centsinteger

Total consumido hasta ahora, en centavos

payment_strategy'card_on_file' | 'preauthorization'

card_on_file cobra al cerrar la tarjeta guardada del cliente. preauthorization mantiene un hold del monto estimado y solo se puede activar desde el dashboard, porque requiere una autorización real del procesador.

opening_commitment'none' | 'manual_amount' | 'product' | 'products'

Qué se comprometió al abrir la cuenta. Se infiere de la solicitud: products si mandaste items, manual_amount si mandaste estimated_amount, none si no mandaste ninguno.

authorized_amount_in_centsinteger

Monto preautorizado con hold sobre la tarjeta, en centavos. 0 cuando no hay preautorización.

authorization_expires_atstring date-time nullable

Momento en que expira el hold de la preautorización

checkout_urlstring nullable

Checkout que cierra la cuenta; pagarlo la marca como paid. Solo aparece mientras la cuenta se está cobrando (closing o paid): si un cobro con tarjeta se declina, la cuenta se reabre y el checkout de ese intento no se publica, porque el cliente no podría pagarlo.

opened_atstring date-time

Momento en que se abrió la cuenta

closed_atstring date-time nullable

Momento en que se cerró la cuenta

created_atstring date-time

Changes

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