Objeto Checkout Session

Sesión de pago que Toku aloja para que un cliente final pague una deuda o inscriba un medio de pago automático.

La organización la crea desde la API y Toku responde con la dirección a la que hay que llevar al cliente final, sea redirigiéndolo o incrustando el portal de pago en su propio sitio.

La sesión no exige un Customer identificado: quien tenga el enlace puede operar sobre ella.

Atributos

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

available_payment_methods array of AvailablePaymentMethod
Medios de pago vigentes del Customer que se pueden asociar al producto en una sesión de inscripción, sin volver a pedirle los datos. Se distinguen de las tarjetas guardadas, que se reutilizan para pagar. Solo de lectura. Toku los resuelve en cada lectura a partir de los medios de pago vigentes del Customer; no se envían al crear la sesión.

available_payment_methods[].brand nullable string
Marca de la tarjeta o red del medio de pago, por ejemplo visa.

available_payment_methods[].cardholder_name nullable string
Nombre del titular de la tarjeta o cuenta.

available_payment_methods[].id_payment_method string (encrypted-id)
Identificador del medio de pago.

available_payment_methods[].institution_name nullable string
Institución financiera del medio de pago, cuando corresponde.

available_payment_methods[].last_4_digits nullable string
Últimos 4 dígitos de la tarjeta o cuenta, para que el cliente la reconozca.

available_payment_methods[].type nullable string
Tipo de medio de pago, por ejemplo tarjeta o cuenta bancaria.

available_saved_cards array of AvailableSavedCard
Tarjetas que el Customer ya tiene guardadas y puede reutilizar para pagar. Solo de lectura. Toku las resuelve en cada lectura a partir de las tarjetas vigentes del Customer; no se envían al crear la sesión.

available_saved_cards[].card_brand nullable string
Marca de la tarjeta, por ejemplo visa o mastercard.

available_saved_cards[].cardholder_name nullable string
Nombre del titular registrado en la tarjeta.

available_saved_cards[].last_4_digits string
Últimos 4 dígitos de la tarjeta, para que el cliente la reconozca.

available_saved_cards[].payment_instrument_card_id string (encrypted-id)
Identificador de la tarjeta guardada.

available_saved_clabes array of AvailableSavedClabe
Cuentas CLABE que el Customer ya tiene guardadas y puede reutilizar para pagar. Solo de lectura. Toku las resuelve en cada lectura a partir de las cuentas vigentes del Customer; no se envían al crear la sesión.

available_saved_clabes[].bank_account_type nullable string
Tipo de cuenta bancaria, por ejemplo CUENTA_CLABE.

available_saved_clabes[].bank_id nullable string
Código de la institución financiera, por ejemplo 044.

available_saved_clabes[].bank_name nullable string
Nombre de la institución financiera de la cuenta.

available_saved_clabes[].id_payment_instrument string (encrypted-id)
Identificador de la cuenta guardada.

available_saved_clabes[].last_4_digits string
Últimos 4 dígitos de la cuenta CLABE, para que el cliente la reconozca.

available_saved_clabes[].last_used_at nullable string
Fecha y hora, en formato ISO 8601, en que la cuenta se usó por última vez.

available_saved_clabes[].source nullable string
Producto de Toku con el que se guardó la cuenta.

available_saved_clabes[].status nullable string
Estado de la cuenta guardada, que define si se puede cobrar con ella.

billing_data SaaSMultipleCustomersOnetimeDetailsResponse | SaaSOnetimeDetailsResponse | SaaSRecurringDetailsResponse | OnDemandOnetimeDetailsResponse | OnDemandRecurringDetailsResponse | SavePaymentInstrumentDetailsResponse | SaaSUnrestrictedAmountOnetimeDetailsResponse
Información necesaria para cobrar una deuda o para inscribir un medio de pago: monto, moneda, deudas, Subscriptions, Customer y Account involucrados.

SaaSMultipleCustomersOnetimeDetailsResponse · Cuando payment_engine es saas_multiple_customers y payment_frequency es onetime

Datos de facturación de una operación SaaS con varios Customers y pago único.

billing_data.account AccountDetailsResponse
Datos de la Account para la que se creó la Checkout Session.

billing_data.account.id_account string (encrypted-id)
Identificador de la Account.

billing_data.account.is_direct_debit nullable boolean
Indica si la Account cobra por domiciliación bancaria.

billing_data.account.is_main boolean
Indica si es la Account principal de la organización.

billing_data.account.name string
Nombre de la Account.

billing_data.currency CurrencyDetails
Moneda en la que se expresan los montos de la operación.

billing_data.currency.code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.currency.decimal_separator string
Separador decimal con el que se muestran los montos.

billing_data.currency.decimals integer
Cantidad de decimales con la que se expresan los montos de la moneda.

billing_data.currency.id_currency string (encrypted-id)
Identificador de la moneda.

billing_data.currency.name string
Nombre de la moneda.

billing_data.currency.symbol string
Símbolo con el que se muestran los montos de la moneda.

billing_data.currency.thousands_separator string
Separador de miles con el que se muestran los montos.

billing_data.customers array of CustomerDetailsResponse
Customers cuyas deudas se cobran en esta Checkout Session.

billing_data.customers[].external_id nullable string
Identificador del Customer en los sistemas de la organización.

billing_data.customers[].government_id nullable string
Documento de identidad del Customer.

billing_data.customers[].id_customer string (encrypted-id)
Identificador del Customer.

billing_data.customers[].mail nullable string
Correo electrónico del Customer.

billing_data.customers[].name nullable string
Nombre del Customer.

billing_data.customers[].phone_number nullable string
Número de teléfono del Customer.

billing_data.invoices array of InvoiceDetailsResponse
Deudas que se cobran en esta Checkout Session.

billing_data.invoices[].amount number
Monto de la deuda.

billing_data.invoices[].currency_code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.invoices[].id_invoice string (encrypted-id)
Identificador de la deuda.

billing_data.invoices[].id_subscription string (encrypted-id)
Identificador de la Subscription.

billing_data.invoices[].is_paid boolean
Indica si la deuda ya está pagada.

billing_data.invoices[].product_id string
Identificador del producto o servicio asociado, definido por la organización.

billing_data.invoices[].product_name nullable string
Nombre del producto a mostrar

billing_data.payment_engine string
Motor con el que Toku procesa la operación.

billing_data.payment_frequency string
Frecuencia del pago; en esta variante siempre es un pago único.

SaaSOnetimeDetailsResponse · Cuando payment_engine es saas y payment_frequency es onetime

Datos de facturación de una operación SaaS de pago único.

billing_data.account AccountDetailsResponse
Datos de la Account para la que se creó la Checkout Session.

billing_data.account.id_account string (encrypted-id)
Identificador de la Account.

billing_data.account.is_direct_debit nullable boolean
Indica si la Account cobra por domiciliación bancaria.

billing_data.account.is_main boolean
Indica si es la Account principal de la organización.

billing_data.account.name string
Nombre de la Account.

billing_data.currency CurrencyDetails
Moneda en la que se expresan los montos de la operación.

billing_data.currency.code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.currency.decimal_separator string
Separador decimal con el que se muestran los montos.

billing_data.currency.decimals integer
Cantidad de decimales con la que se expresan los montos de la moneda.

billing_data.currency.id_currency string (encrypted-id)
Identificador de la moneda.

billing_data.currency.name string
Nombre de la moneda.

billing_data.currency.symbol string
Símbolo con el que se muestran los montos de la moneda.

billing_data.currency.thousands_separator string
Separador de miles con el que se muestran los montos.

billing_data.customer CustomerDetailsResponse
Datos del Customer que realiza la operación.

billing_data.customer.external_id nullable string
Identificador del Customer en los sistemas de la organización.

billing_data.customer.government_id nullable string
Documento de identidad del Customer.

billing_data.customer.id_customer string (encrypted-id)
Identificador del Customer.

billing_data.customer.mail nullable string
Correo electrónico del Customer.

billing_data.customer.name nullable string
Nombre del Customer.

billing_data.customer.phone_number nullable string
Número de teléfono del Customer.

billing_data.invoices array of InvoiceDetailsResponse
Deudas que se cobran en esta Checkout Session.

billing_data.invoices[].amount number
Monto de la deuda.

billing_data.invoices[].currency_code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.invoices[].id_invoice string (encrypted-id)
Identificador de la deuda.

billing_data.invoices[].id_subscription string (encrypted-id)
Identificador de la Subscription.

billing_data.invoices[].is_paid boolean
Indica si la deuda ya está pagada.

billing_data.invoices[].product_id string
Identificador del producto o servicio asociado, definido por la organización.

billing_data.invoices[].product_name nullable string
Nombre del producto a mostrar

billing_data.payment_engine string
Motor con el que Toku procesa la operación.

billing_data.payment_frequency string
Frecuencia del pago; en esta variante siempre es un pago único.

SaaSRecurringDetailsResponse · Cuando payment_engine es saas y payment_frequency es recurring

Datos de facturación de una operación SaaS de pago recurrente.

billing_data.account AccountDetailsResponse
Datos de la Account para la que se creó la Checkout Session.

billing_data.account.id_account string (encrypted-id)
Identificador de la Account.

billing_data.account.is_direct_debit nullable boolean
Indica si la Account cobra por domiciliación bancaria.

billing_data.account.is_main boolean
Indica si es la Account principal de la organización.

billing_data.account.name string
Nombre de la Account.

billing_data.currency CurrencyDetails
Moneda en la que se expresan los montos de la operación.

billing_data.currency.code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.currency.decimal_separator string
Separador decimal con el que se muestran los montos.

billing_data.currency.decimals integer
Cantidad de decimales con la que se expresan los montos de la moneda.

billing_data.currency.id_currency string (encrypted-id)
Identificador de la moneda.

billing_data.currency.name string
Nombre de la moneda.

billing_data.currency.symbol string
Símbolo con el que se muestran los montos de la moneda.

billing_data.currency.thousands_separator string
Separador de miles con el que se muestran los montos.

billing_data.customer CustomerDetailsResponse
Datos del Customer que realiza la operación.

billing_data.customer.external_id nullable string
Identificador del Customer en los sistemas de la organización.

billing_data.customer.government_id nullable string
Documento de identidad del Customer.

billing_data.customer.id_customer string (encrypted-id)
Identificador del Customer.

billing_data.customer.mail nullable string
Correo electrónico del Customer.

billing_data.customer.name nullable string
Nombre del Customer.

billing_data.customer.phone_number nullable string
Número de teléfono del Customer.

billing_data.invoices array of InvoiceDetailsResponse
Deudas que se cobran en esta Checkout Session.

billing_data.invoices[].amount number
Monto de la deuda.

billing_data.invoices[].currency_code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.invoices[].id_invoice string (encrypted-id)
Identificador de la deuda.

billing_data.invoices[].id_subscription string (encrypted-id)
Identificador de la Subscription.

billing_data.invoices[].is_paid boolean
Indica si la deuda ya está pagada.

billing_data.invoices[].product_id string
Identificador del producto o servicio asociado, definido por la organización.

billing_data.invoices[].product_name nullable string
Nombre del producto a mostrar

billing_data.payment_engine string
Motor con el que Toku procesa la operación.

billing_data.payment_frequency string
Frecuencia del pago; en esta variante siempre es un pago recurrente.

billing_data.should_trigger_automatic_payment boolean
Indica si el cobro automático debe iniciarse una vez que la inscripción queda registrada.

billing_data.subscription nullable SubscriptionDetailsResponse
Datos de la Subscription que se está inscribiendo.

billing_data.subscription.additional_metadata nullable object
Datos propios de la organización asociados a la Subscription.

billing_data.subscription.currency_code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.subscription.id_subscription string (encrypted-id)
Identificador de la Subscription.

billing_data.subscription.product_id string
Identificador del producto o servicio asociado, definido por la organización.

billing_data.subscription.product_name nullable string
Nombre a mostrar del producto

billing_data.subscriptions array of SubscriptionDetailsResponse
Datos de las Subscriptions cuando la inscripción cubre varias.

billing_data.subscriptions[].additional_metadata nullable object
Datos propios de la organización asociados a la Subscription.

billing_data.subscriptions[].currency_code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.subscriptions[].id_subscription string (encrypted-id)
Identificador de la Subscription.

billing_data.subscriptions[].product_id string
Identificador del producto o servicio asociado, definido por la organización.

billing_data.subscriptions[].product_name nullable string
Nombre a mostrar del producto

OnDemandOnetimeDetailsResponse · Cuando payment_engine es on_demand y payment_frequency es onetime

Datos de facturación de una operación on-demand de pago único.

billing_data.account AccountDetailsResponse
Datos de la Account para la que se creó la Checkout Session.

billing_data.account.id_account string (encrypted-id)
Identificador de la Account.

billing_data.account.is_direct_debit nullable boolean
Indica si la Account cobra por domiciliación bancaria.

billing_data.account.is_main boolean
Indica si es la Account principal de la organización.

billing_data.account.name string
Nombre de la Account.

billing_data.amount number
Monto que se cobra en la Checkout Session.

billing_data.currency CurrencyDetails
Moneda en la que se expresan los montos de la operación.

billing_data.currency.code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.currency.decimal_separator string
Separador decimal con el que se muestran los montos.

billing_data.currency.decimals integer
Cantidad de decimales con la que se expresan los montos de la moneda.

billing_data.currency.id_currency string (encrypted-id)
Identificador de la moneda.

billing_data.currency.name string
Nombre de la moneda.

billing_data.currency.symbol string
Símbolo con el que se muestran los montos de la moneda.

billing_data.currency.thousands_separator string
Separador de miles con el que se muestran los montos.

billing_data.customer nullable CustomerDetailsResponse
Datos del Customer, cuando la operación tiene uno asociado.

billing_data.customer.external_id nullable string
Identificador del Customer en los sistemas de la organización.

billing_data.customer.government_id nullable string
Documento de identidad del Customer.

billing_data.customer.id_customer string (encrypted-id)
Identificador del Customer.

billing_data.customer.mail nullable string
Correo electrónico del Customer.

billing_data.customer.name nullable string
Nombre del Customer.

billing_data.customer.phone_number nullable string
Número de teléfono del Customer.

billing_data.payment_engine string
Motor con el que Toku procesa la operación.

billing_data.payment_frequency string
Frecuencia del pago; en esta variante siempre es un pago único.

OnDemandRecurringDetailsResponse · Cuando payment_engine es on_demand y payment_frequency es recurring

Datos de facturación de una operación on-demand de pago recurrente.

billing_data.account AccountDetailsResponse
Datos de la Account para la que se creó la Checkout Session.

billing_data.account.id_account string (encrypted-id)
Identificador de la Account.

billing_data.account.is_direct_debit nullable boolean
Indica si la Account cobra por domiciliación bancaria.

billing_data.account.is_main boolean
Indica si es la Account principal de la organización.

billing_data.account.name string
Nombre de la Account.

billing_data.currency CurrencyDetails
Moneda en la que se expresan los montos de la operación.

billing_data.currency.code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.currency.decimal_separator string
Separador decimal con el que se muestran los montos.

billing_data.currency.decimals integer
Cantidad de decimales con la que se expresan los montos de la moneda.

billing_data.currency.id_currency string (encrypted-id)
Identificador de la moneda.

billing_data.currency.name string
Nombre de la moneda.

billing_data.currency.symbol string
Símbolo con el que se muestran los montos de la moneda.

billing_data.currency.thousands_separator string
Separador de miles con el que se muestran los montos.

billing_data.customer nullable CustomerDetailsResponse
Datos del Customer, cuando la operación tiene uno asociado.

billing_data.customer.external_id nullable string
Identificador del Customer en los sistemas de la organización.

billing_data.customer.government_id nullable string
Documento de identidad del Customer.

billing_data.customer.id_customer string (encrypted-id)
Identificador del Customer.

billing_data.customer.mail nullable string
Correo electrónico del Customer.

billing_data.customer.name nullable string
Nombre del Customer.

billing_data.customer.phone_number nullable string
Número de teléfono del Customer.

billing_data.payment_engine string
Motor con el que Toku procesa la operación.

billing_data.payment_frequency string
Frecuencia del pago; en esta variante siempre es un pago recurrente.

billing_data.should_trigger_automatic_payment boolean
Indica si el cobro automático debe iniciarse una vez que la inscripción queda registrada.

SavePaymentInstrumentDetailsResponse · Cuando payment_engine es null y payment_frequency es null

Datos de una operación que solo guarda un medio de pago.

billing_data.account AccountDetailsResponse
Datos de la Account para la que se creó la Checkout Session.

billing_data.account.id_account string (encrypted-id)
Identificador de la Account.

billing_data.account.is_direct_debit nullable boolean
Indica si la Account cobra por domiciliación bancaria.

billing_data.account.is_main boolean
Indica si es la Account principal de la organización.

billing_data.account.name string
Nombre de la Account.

billing_data.amount nullable number
Monto asociado a la Checkout Session, si tiene uno. En este modo no se cobra.

billing_data.currency nullable CurrencyDetails
Moneda en la que se expresan los montos de la operación.

billing_data.currency.code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.currency.decimal_separator string
Separador decimal con el que se muestran los montos.

billing_data.currency.decimals integer
Cantidad de decimales con la que se expresan los montos de la moneda.

billing_data.currency.id_currency string (encrypted-id)
Identificador de la moneda.

billing_data.currency.name string
Nombre de la moneda.

billing_data.currency.symbol string
Símbolo con el que se muestran los montos de la moneda.

billing_data.currency.thousands_separator string
Separador de miles con el que se muestran los montos.

billing_data.customer nullable CustomerDetailsResponse
Datos del Customer, cuando la operación tiene uno asociado.

billing_data.customer.external_id nullable string
Identificador del Customer en los sistemas de la organización.

billing_data.customer.government_id nullable string
Documento de identidad del Customer.

billing_data.customer.id_customer string (encrypted-id)
Identificador del Customer.

billing_data.customer.mail nullable string
Correo electrónico del Customer.

billing_data.customer.name nullable string
Nombre del Customer.

billing_data.customer.phone_number nullable string
Número de teléfono del Customer.

billing_data.payment_engine null
No aplica: en este modo no se procesa un cobro, así que no hay motor de pago.

billing_data.payment_frequency null
No aplica: una sesión que solo guarda un medio de pago no tiene frecuencia de pago.

SaaSUnrestrictedAmountOnetimeDetailsResponse · Cuando payment_engine es saas_unrestricted_amount y payment_frequency es onetime

Datos de facturación de una operación SaaS de monto sin restricción y pago único.

billing_data.account AccountDetailsResponse
Datos de la Account para la que se creó la Checkout Session.

billing_data.account.id_account string (encrypted-id)
Identificador de la Account.

billing_data.account.is_direct_debit nullable boolean
Indica si la Account cobra por domiciliación bancaria.

billing_data.account.is_main boolean
Indica si es la Account principal de la organización.

billing_data.account.name string
Nombre de la Account.

billing_data.amount number
Monto que se cobra en la Checkout Session.

billing_data.currency CurrencyDetails
Moneda en la que se expresan los montos de la operación.

billing_data.currency.code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.currency.decimal_separator string
Separador decimal con el que se muestran los montos.

billing_data.currency.decimals integer
Cantidad de decimales con la que se expresan los montos de la moneda.

billing_data.currency.id_currency string (encrypted-id)
Identificador de la moneda.

billing_data.currency.name string
Nombre de la moneda.

billing_data.currency.symbol string
Símbolo con el que se muestran los montos de la moneda.

billing_data.currency.thousands_separator string
Separador de miles con el que se muestran los montos.

billing_data.customer CustomerDetailsResponse
Datos del Customer que realiza la operación.

billing_data.customer.external_id nullable string
Identificador del Customer en los sistemas de la organización.

billing_data.customer.government_id nullable string
Documento de identidad del Customer.

billing_data.customer.id_customer string (encrypted-id)
Identificador del Customer.

billing_data.customer.mail nullable string
Correo electrónico del Customer.

billing_data.customer.name nullable string
Nombre del Customer.

billing_data.customer.phone_number nullable string
Número de teléfono del Customer.

billing_data.invoices array of InvoiceDetailsResponse
Deudas que se cobran en esta Checkout Session.

billing_data.invoices[].amount number
Monto de la deuda.

billing_data.invoices[].currency_code string
Código de la moneda, por ejemplo CLP o MXN.

billing_data.invoices[].id_invoice string (encrypted-id)
Identificador de la deuda.

billing_data.invoices[].id_subscription string (encrypted-id)
Identificador de la Subscription.

billing_data.invoices[].is_paid boolean
Indica si la deuda ya está pagada.

billing_data.invoices[].product_id string
Identificador del producto o servicio asociado, definido por la organización.

billing_data.invoices[].product_name nullable string
Nombre del producto a mostrar

billing_data.payment_engine string
Motor con el que Toku procesa la operación.

billing_data.payment_frequency string
Frecuencia del pago; en esta variante siempre es un pago único.

card_flow_config nullable object
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.

checkout_config nullable CheckoutPresentationConfig
Ajustes de presentación del checkout para esta sesión. Es nulo cuando la sesión no tiene configuración de pago único. Solo de lectura. Toku lo resuelve en cada lectura a partir de la configuración de checkout de la organización.

checkout_config.disable_back_button_deep_link nullable boolean
Indica si el botón de volver al comercio está deshabilitado. Es la polaridad inversa de la configuración de origen, que declara cuándo mostrar el botón.

checkout_config.go_back_to_commerce_url nullable string
URL del comercio a la que vuelve el cliente al salir del checkout.

checkout_config.show_checkout_invoice_breakdown nullable boolean
Indica si el detalle de la deuda se muestra desglosado por ítem.

checkout_config.show_pci_compliance_badge nullable boolean
Indica si el checkout muestra la insignia PCI DSS Compliant que emitió nuestro QSA. Sólo puede mostrarse esa insignia: el logo del PCI SSC y las insignias no oficiales están prohibidos por su guía de marca.

checkout_config.show_wallet_discount nullable boolean
Indica si se muestra el descuento por pagar con billetera.

combine_active nullable boolean
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_enabled nullable boolean
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.

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

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

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

flow_name string
Flow con el que se creó la Checkout Session.

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

invoice_data nullable InvoiceData
Datos de la deuda que se creó junto con la Checkout Session, cuando la sesión cobra una deuda nueva.

invoice_data.amount number
Monto total de la deuda que se cobra en la sesión.

invoice_data.currency_code string
Moneda en la que está expresado el monto de la deuda.

Valores posibles: CLP, CLF, MXN, BRL, USD.

invoice_data.disable_automatic_payment boolean
Indica si la deuda queda excluida de los cobros automáticos, de modo que solo se pague desde este checkout.

invoice_data.due_date string
Fecha de vencimiento de la deuda, en formato ISO 8601.

invoice_data.expiration_action string
Qué se hace con la deuda cuando llega su fecha de expiración.

Valores posibles: EXPIRE, VOID, DELETE.

invoice_data.expiration_date string
Fecha en la que la deuda expira, en formato ISO 8601.

invoice_data.invoice_external_id string
Identificador de la deuda en los sistemas de la organización, para poder conciliarla.

invoice_data.max_collection_attempts integer
Cantidad máxima de intentos de cobro automático de la deuda.

invoice_data.metadata object
Datos propios de la organización que se guardan junto a la deuda y no afectan el cobro.

invoice_data.product_id string
Identificador del producto o servicio que se está cobrando, definido por la organización.

invoice_data.will_expire boolean
Indica si la deuda expira al llegar su fecha de expiración.

is_receipt_redirection_disabled nullable boolean
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 nullable string
Qué operación completa el cliente final en la sesión: PAYMENT cobra deudas o un monto puntual y termina en un pago, ENROLLMENT inscribe un medio de pago automático para cobrarle después, y SAVE_PAYMENT_INSTRUMENT solo registra una cuenta bancaria del Customer, sin cobrar ni inscribir un medio de pago.

Valores posibles: ENROLLMENT, PAYMENT, SAVE_PAYMENT_INSTRUMENT.

operation_id nullable string
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.

pac_inscription_config nullable PacInscriptionPresentationConfig
Configuración de la inscripción de PAC para esta sesión. Es nulo cuando la sesión no define exclusiones de instituciones. Solo de lectura. Toku la resuelve en cada lectura a partir de la configuración de checkout de la organización.

pac_inscription_config.accepted_account_types_by_institution array of PacInscriptionInstitutionAccountTypes
Restricción de tipos de cuenta aceptados por institución al inscribir un PAC. Una institución sin entrada acepta todos los tipos de cuenta.

pac_inscription_config.accepted_account_types_by_institution[].accepted_account_types array of string
Tipos de cuenta aceptados para inscribir un PAC en esta institución: checking_account (cuenta corriente), sight_account (cuenta vista; la chequera electrónica cuenta como cuenta vista) o rut_account (CuentaRUT).

Valores posibles: checking_account, rut_account, sight_account.

pac_inscription_config.accepted_account_types_by_institution[].institution string
Institución bancaria a la que aplica la restricción de tipos de cuenta.

pac_inscription_config.excluded_institutions array of string
Instituciones bancarias que no se ofrecen al cliente al inscribir un PAC en esta Checkout Session.

payment_options array of InternalPaymentOption | ExternalPaymentOption | SyntheticPaymentOption
Medios de pago que se le ofrecen al cliente final en esta Checkout Session. Solo de lectura. Toku los arma en cada lectura a partir del flow_name de la sesión, su mode y la payment_options_configuration con la que se creó.

InternalPaymentOption · Cuando payment_option_type es internal

Medio de pago que el cliente final completa dentro del checkout de Toku.

payment_options[].display string
Cómo se presenta el medio de pago: a la vista o dentro de una sección desplegable.

Valores posibles: main_view, expandable.

payment_options[].form CardFormSchema | AccountMXFormSchema | TransferCLFormSchema | TransferMXFormSchema | CashMXFormSchema | CoDiFormSchema | BoletoFormSchema | DirectDebitCLFormSchema | PacInscriptionFormSchema | PixBankingFormSchema | PixBankingAutomaticFormSchema | PixOpenfinanceOnetimeFormSchema | PixOpenfinanceRecurringFormSchema | TransbankWebpayPlusFormSchema | TransbankOneclickFormSchema | WalletMXFormSchema | ExternalCollectorsCLFormSchema

payment_options[].payment_option_type string
Tipo de medio de pago, que determina cómo se completa el pago.

payment_options[].priority integer
Orden en que se muestra el medio de pago frente a los demás.

ExternalPaymentOption · Cuando payment_option_type es external

Medio de pago que se completa fuera del checkout, en un sitio al que se redirige al cliente final.

payment_options[].display string
Cómo se presenta el medio de pago: a la vista o dentro de una sección desplegable.

Valores posibles: main_view, expandable.

payment_options[].label string
Texto con el que se identifica el medio de pago en el checkout.

payment_options[].link string
Enlace externo al que se redirige al cliente final para pagar.

payment_options[].payment_option_type string
Tipo de medio de pago, que determina cómo se completa el pago.

payment_options[].priority integer
Orden en que se muestra el medio de pago frente a los demás.

SyntheticPaymentOption · Cuando payment_option_type es synthetic

Opción que el checkout muestra como si fuera un medio de pago, pero que en realidad abre otro flujo, como pagar el total en varios pagos.

payment_options[].display string
Cómo se presenta el medio de pago: a la vista o dentro de una sección desplegable.

Valores posibles: main_view, expandable.

payment_options[].payment_option_type string
Tipo de medio de pago, que determina cómo se completa el pago.

payment_options[].priority integer
Orden en que se muestra el medio de pago frente a los demás.

payment_options[].synthetic_type string
Flujo que abre la opción, por ejemplo pagar el total en varios pagos.

payment_options_configuration nullable PaymentOptionsConfigurationResponse
Configuración con la que se muestra y procesa cada medio de pago del checkout.

payment_options_configuration.card nullable CardConfigurationResponse
Configuración con la que se muestra y se procesa el pago con tarjeta en el checkout.

payment_options_configuration.card.combine_payment_methods nullable CombinePaymentMethodsConfigurationResponse
Reglas con las que el cliente final puede pagar el total repartido en varios pagos.

payment_options_configuration.card.combine_payment_methods.enabled nullable boolean
Indica si esta Checkout Session admite pagar el total en varios pagos.

payment_options_configuration.card.combine_payment_methods.max_payments nullable integer
Cantidad máxima de pagos con los que se puede cubrir el total.

payment_options_configuration.card.combine_payment_methods.min_amount nullable integer
Monto mínimo de cada pago, en la unidad mínima de la moneda de la sesión (por ejemplo, centavos).

payment_options_configuration.card.combine_payment_methods.ttl_refund_minutes nullable integer
Minutos que se esperan desde el primer pago antes de devolver lo ya cobrado si la combinación no se completa.

payment_options_configuration.card.enable_toggle_switch nullable boolean
Indica si el checkout ofrece al cliente final guardar la tarjeta para próximos pagos.

payment_options_configuration.card.external_processors nullable ExternalProcessorsEnabled
Billeteras externas habilitadas para pagar con tarjeta en esta sesión.

payment_options_configuration.card.external_processors.apple_pay ApplePayConfig
Disponibilidad de Apple Pay para el medio de pago con tarjeta, resuelta por Toku al crear la sesión.

payment_options_configuration.card.external_processors.apple_pay.enabled boolean

payment_options_configuration.card.external_processors.apple_pay.partner_internal_merchant_identifier string

payment_options_configuration.card.external_processors.apple_pay.supported_countries array of string

payment_options_configuration.card.external_processors.apple_pay.supported_networks array of string

payment_options_configuration.card.external_processors.apple_pay.supported_types array of string

payment_options_configuration.card.external_processors.apple_pay.token_notification_url string

payment_options_configuration.card.external_processors.google_pay GooglePayConfig
Disponibilidad y configuración de Google Pay para el medio de pago con tarjeta, resuelta por Toku al crear la sesión.

payment_options_configuration.card.external_processors.google_pay.enabled boolean

payment_options_configuration.card.external_processors.google_pay.merchant_id string

payment_options_configuration.card.force_3ds nullable boolean
Indica si el cobro exige siempre la autenticación 3-D Secure del emisor de la tarjeta.

payment_options_configuration.card.id_orchestration_tree nullable string
Identificador de la configuración con la que Toku resuelve por qué procesador se cobra la tarjeta. Debiera utilizarse solo para orquestaciones custom y complejas.

payment_options_configuration.card.installments_configuration nullable object
Reglas de cuotas ofrecidas al cliente final, como el máximo de cuotas y el monto mínimo por cuota.

payment_options_configuration.card.selected_card nullable string
Tarjeta ya guardada que el checkout deja preseleccionada.

payment_options_configuration.pac nullable PacConfigurationResponse
Configuración con la que se muestra la inscripción de un mandato en PAC.

payment_options_configuration.pac.mandate_id string
Identificador del mandato de PAC asociado a la inscripción.

payment_options_configuration.transfer_cl nullable TransferClConfigurationResponse
Configuración con la que se muestra el pago por transferencia bancaria en el checkout.

payment_options_configuration.transfer_cl.available_institutions array of string
Instituciones financieras desde las que el cliente final puede transferir.

redirection nullable string
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.

selected_saved_card nullable AvailableSavedCard
Tarjeta guardada que queda preseleccionada, de modo que el cliente final no deba elegirla. Solo de lectura. Toku la resuelve en cada lectura a partir de payment_options_configuration.card.selected_card, que es el campo que sí se envía al crear la sesión. Es nula si esa tarjeta dejó de estar vigente o si la organización no tiene habilitado el pago con un medio ya guardado.

selected_saved_card.card_brand nullable string
Marca de la tarjeta, por ejemplo visa o mastercard.

selected_saved_card.cardholder_name nullable string
Nombre del titular registrado en la tarjeta.

selected_saved_card.last_4_digits string
Últimos 4 dígitos de la tarjeta, para que el cliente la reconozca.

selected_saved_card.payment_instrument_card_id string (encrypted-id)
Identificador de la tarjeta guardada.

session_price_change_origin nullable string
Origen del ajuste de precio de la sesión: adjustment_document cuando se desprende de un saldo a favor del Customer y specified_at_creation cuando se envió en el cuerpo con el que se creó la sesión. Los dos son excluyentes. Es nulo cuando no hay ajustes. Solo de lectura. Toku lo determina junto con session_price_changes_total.

Valores posibles: adjustment_document, specified_at_creation.

session_price_changes_total nullable number
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.

state string
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.

Ejemplo

{
  "allow_partial_payment": false,
  "available_payment_methods": [
    {
      "brand": "string",
      "cardholder_name": "string",
      "id_payment_method": "string",
      "institution_name": "string",
      "last_4_digits": "string",
      "type": "string"
    }
  ],
  "available_saved_cards": [
    {
      "card_brand": "string",
      "cardholder_name": "string",
      "last_4_digits": "string",
      "payment_instrument_card_id": "pin_7xIjuUhyYGYlk_fNUTuUurwXynRDrlfV"
    }
  ],
  "available_saved_clabes": [
    {
      "bank_account_type": "string",
      "bank_id": "string",
      "bank_name": "string",
      "id_payment_instrument": "pin_tpXwYTm_uFKy77emonKoiAywjlyAUL_H",
      "last_4_digits": "string",
      "last_used_at": "string",
      "source": "string",
      "status": "string"
    }
  ],
  "billing_data": {
    "account": {
      "id_account": "string",
      "is_direct_debit": false,
      "is_main": false,
      "name": "string"
    },
    "currency": {
      "code": "string",
      "decimal_separator": "string",
      "decimals": 0,
      "id_currency": "string",
      "name": "string",
      "symbol": "string",
      "thousands_separator": "string"
    },
    "customers": [
      {
        "external_id": "string",
        "government_id": "string",
        "id_customer": "string",
        "mail": "string",
        "name": "string",
        "phone_number": "string"
      }
    ],
    "invoices": [
      {
        "amount": 0,
        "currency_code": "string",
        "id_invoice": "string",
        "id_subscription": "string",
        "is_paid": false,
        "product_id": "string",
        "product_name": "string"
      }
    ],
    "payment_engine": "saas_multiple_customers",
    "payment_frequency": "onetime"
  },
  "card_flow_config": {},
  "checkout_config": {
    "disable_back_button_deep_link": false,
    "go_back_to_commerce_url": "string",
    "show_checkout_invoice_breakdown": false,
    "show_pci_compliance_badge": false,
    "show_wallet_discount": false
  },
  "combine_active": false,
  "combine_enabled": false,
  "disable_oneclick_checkout": false,
  "expiration_datetime": "string",
  "external_id": "string",
  "flow_name": "string",
  "id_checkout_session": "string",
  "invoice_data": {
    "amount": 0,
    "currency_code": "CLP",
    "disable_automatic_payment": true,
    "due_date": "string",
    "expiration_action": "EXPIRE",
    "expiration_date": "string",
    "invoice_external_id": "string",
    "max_collection_attempts": 0,
    "metadata": {},
    "product_id": "string",
    "will_expire": true
  },
  "is_receipt_redirection_disabled": false,
  "mode": "ENROLLMENT",
  "operation_id": "string",
  "pac_inscription_config": {
    "accepted_account_types_by_institution": [
      {
        "accepted_account_types": [
          "checking_account"
        ],
        "institution": "string"
      }
    ],
    "excluded_institutions": [
      "string"
    ]
  },
  "payment_options": [
    {
      "display": "main_view",
      "form": {
        "form_configuration": {},
        "form_type": "card",
        "intention": "string",
        "payment_processing_configuration": {
          "main_toku_product": "string",
          "payment_processing_type": "toku_product",
          "price_changes": {},
          "toku_products": [
            "string"
          ]
        }
      },
      "payment_option_type": "internal",
      "priority": 0
    }
  ],
  "payment_options_configuration": {
    "card": {
      "combine_payment_methods": {
        "enabled": false,
        "max_payments": 0,
        "min_amount": 0,
        "ttl_refund_minutes": 0
      },
      "enable_toggle_switch": false,
      "external_processors": {
        "apple_pay": {
          "enabled": false,
          "partner_internal_merchant_identifier": "string",
          "supported_countries": [
            "string"
          ],
          "supported_networks": [],
          "supported_types": [
            "string"
          ],
          "token_notification_url": "string"
        },
        "google_pay": {
          "enabled": false,
          "merchant_id": "string"
        }
      },
      "force_3ds": false,
      "id_orchestration_tree": "string",
      "installments_configuration": {},
      "selected_card": "string"
    },
    "pac": {
      "mandate_id": "string"
    },
    "transfer_cl": {
      "available_institutions": [
        "string"
      ]
    }
  },
  "redirection": "string",
  "selected_saved_card": {
    "card_brand": "string",
    "cardholder_name": "string",
    "last_4_digits": "string",
    "payment_instrument_card_id": "pin_7xIjuUhyYGYlk_fNUTuUurwXynRDrlfV"
  },
  "session_price_change_origin": "adjustment_document",
  "session_price_changes_total": 0,
  "state": "string"
}