checkouts

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.

get/checkouts

Query parameters

pageinteger

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

itemsinteger

Elementos por página

user_idstring

Filtrar por ID de usuario

from_timestring date-time

Filtrar desde esta fecha (formato ISO 8601)

until_timestring date-time

Filtrar hasta esta fecha (formato ISO 8601)

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.

Response

Lista de checkouts

idstring required

ID único del checkout

status'unpaid' | 'paid' | 'payment_in_progress' | 'expired' required

Estado del checkout

total_in_centsinteger

Monto total en centavos (después de descuentos)

subtotal_in_centsinteger

Monto subtotal en centavos (antes de descuentos)

currency'GTQ' | 'USD'

Moneda del checkout

payment_method_typesCheckoutPaymentMethodTypesItems[]

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_installmentsinteger[]

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

live_modeboolean

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

success_urlstring

URL de redirección en caso de pago exitoso

cancel_urlstring

URL de redirección en caso de cancelación

expires_atstring date-time

Fecha de expiración del checkout

created_atstring date-time

Fecha de creación

Changes

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