RErecurrente
checkouts

Listar checkouts

Changed on

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

Request

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)

Response

Lista de checkouts

idstring required

ID único del checkout

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

Estado del checkout

bank_transfer_memostring nullable

Referencia normalizada propuesta por la integración. Es null cuando Recurrente generará la referencia al iniciar el pago por transferencia.

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

application_fee_amountinteger nullable

Comisión de plataforma en centavos (pagos únicos): la suma de las transferencias de comisión del checkout. null cuando no hay comisión.

application_fee_percentnumber double nullable

Comisión de plataforma como porcentaje del total de cada factura (suscripciones). null cuando no hay comisión.

Changes

  • 3d76463f9fd8Revision changes
    • warning

      deleted the header request parameter X-SECRET-KEY

    • info

      the endpoint scheme security secretKey was added to the API

  • 3f07af5cbba7Revision changes
    • info

      api operation id list-checkouts removed and replaced with checkouts_listCheckouts