TRtrytoku
Checkout Session

Obtener Checkout Session

Devuelve la información de una Checkout Session: su estado, los datos de facturación, la configuración de medios de pago y la url de pago.

Se usa para consultar en qué quedó una sesión ya creada — por ejemplo, para saber si sigue OPEN, si expiró o si el cliente completó el pago.

Solo se puede consultar una Checkout Session de la organización autenticada.

get/{country_code}/checkout-sessions/{checkout_session_id}

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/{country_code}/checkout-sessions/{checkout_session_id}
  • Auth
    API key in header x-api-key

Path parameters

country_code'cl' | 'mx' | 'br' required

País de la organización sobre la que se opera, como primer segmento de la ruta: cl (Chile), mx (México) o br (Brasil).

checkout_session_idstring uuid required

Identificador único de la Checkout Session.

Headers

x-api-versionstring date

Versión del API para esta petición, como cualquier fecha YYYY-MM-DD. Fija el contrato de la respuesta; si se omite, se deriva de la fecha de creación de la organización.

Example:2026-10-08
x-sourcestring

Origen de la consulta, solo para trazabilidad: merchant_api o payment_portal. Si se omite o no se reconoce, la lectura se registra como merchant_api.

Response

Estado actual de la Checkout Session.

allow_partial_paymentboolean nullable

Indica si el cliente final puede abonar solo una parte del total en lugar de pagarlo completo.

card_flow_configobject nullable

Configuración resuelta para el pago con tarjeta de esta sesión: por qué procesador se cobra, restricciones de tarjetas aceptadas, autenticación 3-D Secure y cuotas. Corresponde al tipo de sesión: un pago único lleva la configuración de pago único, y una inscripción o el guardado de un medio de pago llevan la recurrente. Es nulo cuando no aplica ninguna configuración. Solo de lectura. Toku la resuelve en cada lectura a partir de la configuración de tarjeta de la organización y del mode de la sesión.

combine_activeboolean nullable

Indica si esta Checkout Session tiene una combinación de pagos en curso: ya hay al menos un pago, falta saldo, la sesión sigue abierta y no se cumplió el plazo para devolver lo cobrado. Solo de lectura. Toku lo calcula en cada lectura a partir de los pagos ya hechos sobre la sesión.

combine_enabledboolean nullable

Indica si se le puede ofrecer al cliente final pagar el total en varios pagos. Deja de ser verdadero una vez que hay un pago parcial hecho: para una combinación en curso se usa combine_active. Solo de lectura. Toku lo calcula en cada lectura a partir de la configuración de la organización y del estado de la sesión.

customer_pii_maskedboolean nullable

Indica si los datos personales del Customer (name, mail, phone_number, government_id y external_id) vienen enmascarados. Cuando es true los valores no son utilizables: hay que pedirlos de nuevo antes de enviarlos. Solo de lectura. Toku lo resuelve en cada lectura según la configuración de la organización.

disable_oneclick_checkoutboolean nullable

Indica si en esta Checkout Session se desactiva el pago con un medio ya guardado, aunque la organización lo tenga habilitado.

expiration_datetimestring nullable

Fecha y hora, en formato ISO 8601, en la que la Checkout Session expira.

external_idstring nullable

Identificador que entrega la organización para reconocer después los pagos o inscripciones hechos con esta Checkout Session.

flow_namestring required

Flow con el que se creó la Checkout Session.

id_checkout_sessionstring required

Identificador único de la Checkout Session. Solo de lectura. Toku lo genera al crear la sesión.

is_receipt_redirection_disabledboolean nullable

Indica si el comprobante no redirige al cliente final. El comprobante se muestra igual: lo que se desactiva es la redirección que sale desde él una vez terminada la operación. Solo de lectura. Toku lo calcula en cada lectura: es verdadero mientras la sesión cobre un monto o deudas con un medio de pago que cobra de forma diferida y todavía no tenga un pago exitoso, porque hasta entonces no hay un resultado que mostrar al otro lado.

mode'ENROLLMENT' | 'PAYMENT' | 'SAVE_PAYMENT_INSTRUMENT'

Modo de una Checkout Session.

operation_idstring nullable

Identificador de la operación con la que se completó la Checkout Session. Solo de lectura. Toku lo estampa al completar la sesión; es nulo mientras siga abierta.

redirectionstring nullable

Identificador de la redirección a la que se envía al cliente final al terminar. Solo de lectura. Toku la crea al crear la sesión, a partir del redirection_data de la petición.

session_price_change_origin'adjustment_document' | 'specified_at_creation'

Where a checkout session's price change came from, for portal labelling.

session_price_changes_totalnumber nullable

Suma de los ajustes de precio aplicados solo a esta Checkout Session. Un valor negativo reduce el total a pagar, por ejemplo un crédito a favor; es cero cuando no hay ajustes. Solo de lectura. Toku lo calcula en cada lectura a partir del price_change con el que se creó la sesión y de los saldos a favor del Customer.

statestring required

Estado de la Checkout Session: OPEN mientras se puede pagar, COMPLETED o EXPIRED al cerrarse. Solo de lectura. Lo maneja Toku: la sesión nace OPEN y pasa a COMPLETED cuando se completa la operación o a EXPIRED cuando vence.

urlstring required

Dirección que se le entrega al cliente final para pagar o inscribir el medio de pago.

Changes

No recorded changes to this operation across all 2 revisions of this API.