Referencia APICheckouts

Listar checkouts

Lista con paginación todos los checkouts que pertenecen a la cuenta del contexto. Sin X-ACCOUNT-ID, usa la cuenta dueña de la llave. Una plataforma puede enviar X-ACCOUNT-ID para listar todos los checkouts de una hija conectada, sin importar si los creó la plataforma o la hija. Puedes filtrar por fechas y usuario.

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`.

Query parameters

pageintegerOptional>=1Defaults to 1

Número de página (empezando en 1)

itemsintegerOptional1-100Defaults to 10

Elementos por página

user_idstringOptional
Filtrar por ID de usuario
from_timedatetimeOptional

Filtrar desde esta fecha (formato ISO 8601)

until_timedatetimeOptional

Filtrar hasta esta fecha (formato ISO 8601)

Response

Lista de checkouts
idstring

ID único del checkout

statusenum
Estado del checkout
itemslist of objects

Colección completa de filas mutables del checkout. No incluye descuentos, envío, fees ni prorrateos derivados.

total_in_centsintegerOptional

Monto total en centavos (después de descuentos)

subtotal_in_centsintegerOptional

Monto subtotal en centavos (antes de descuentos)

discountobject or nullOptional

Descuento aplicado al checkout (null si no hay descuento)

currencyenumOptional
Moneda del checkout
payment_method_typeslist of enumsOptional

Métodos de pago que se le ofrecerán al comprador en este checkout, ya resueltos según la configuración del producto/cuenta, la moneda y el tipo de cobro: card (tarjeta, pago de contado), bank_transfer (transferencia bancaria), stablecoins (dólares digitales), balance (Balance Recurrente). Las cuotas se exponen por separado en available_installments; card indica pago de contado, así que un checkout puede ofrecer cuotas (available_installments no vacío) sin incluir card.

available_installmentslist of integersOptional

Opciones de cuotas (en meses) disponibles en este checkout, independientes de payment_method_types. Vacío si no se ofrecen cuotas.

live_modebooleanOptional

Si el checkout está en modo producción (true) o prueba (false)

success_urlstringOptional

URL de redirección en caso de pago exitoso

cancel_urlstringOptional

URL de redirección en caso de cancelación

expires_atdatetimeOptional

Fecha de expiración del checkout

created_atdatetimeOptional

Fecha de creación

metadatastring or double or booleanOptional
Metadata personalizada del checkout
custom_fieldslist of objectsOptional

Valores recolectados de los campos personalizados. Si el checkout tiene múltiples productos, cada producto contribuye sus propias entradas — la key puede repetirse entre productos. Usa field_id como identificador canónico al reconciliar valores.

transfer_setupslist of objectsOptional
Configuraciones de transferencia asociadas
latest_intentobject or nullOptional

Último intent unificado asociado. Su id usa el prefijo in_….

paymentobject or nullOptional

Información del pago (si está pagado)

payment_methodobject or nullOptional

Método de pago utilizado