RErecurrente
serviceTabs

Listar cuentas abiertas

Changed on

Lista las cuentas abiertas de tu cuenta, de la más reciente a la más antigua. Filtra por estado con status para, por ejemplo, ver solo las que siguen abiertas.

get/service_tabs

Request

Query parameters

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

Devuelve solo las cuentas en este estado

from_timestring date-time

Inicio del rango de fechas (se usa junto con until_time)

until_timestring date-time

Fin del rango de fechas (se usa junto con from_time)

pageinteger
per_pageinteger

Response

Lista de cuentas abiertas

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

  • 33bad9197d59Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • breaking

      the / response's property type changed from object to array for status

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API