El objeto Checkout Session representa una sesión de pago en Toku que contiene toda la información necesaria para procesar un pago, incluyendo datos de facturación, configuración de métodos de pago, y el estado actual de la transacción.
Atributos
id type: string
type: stringIdentificador único interno de Toku para la Checkout Session
billing_data type: dict
type: dictInformación necesaria para poder procesar el pago de una deuda o para suscribir un medio de pago
billing_data.amount type: float
type: floatMonto a cobrar en la sesión de checkout. Solo disponible para cuando la checkout session esta en modo PAYMENT
billing_data.currency type: string
type: stringMoneda a utilizar en la operación billing_data.amount.
billing_data.ids_invoice
Es posible crear checkout session para pagar algunas deudas previamente creadas, este atributo corresponde a los ids. Solo es validó cuando la checkout session se esta creando en modo ``PAYMENT```
billing_data.id_subscription
Es posible crear checkout session para subscribir un método de pago automático en algunos productos, este atributo corresponde a los ids de los productos. Solo es validó cuando la checkout session se esta creando en modo ENROLLMENT
payment_engine
Tipo de motor de pago, definido por toku, para procesar el pago. Puede ser saas o onetime.
payment_frecuency
Frecuencia de pago del producto que se utilizará en la checkout session. Definido por Toku. Puede ser onetime o recurring
account
Información de la cuenta para la cual se creo la Checkout Session.
account.id
Identificador unico para la cuenta para la cual se creó la Checkout Session.
account.name
Nombre de la cuenta para la cual se creó la Checkout Session
account.is_main
Atributo que permite identificar si es que la cuenta para la cual se creó una Checkout Session, corresponde a una cuenta principal
customer
Información de la cuenta para la cual se creo la Checkout Session, si es que corresponde.
customer.id
Identificador unico para el Customer.
customer.name
Nombre del Customer
customer.email
Email del Customer
customer.external_id
Id externo del Customer
customer.phone_number
Número de teléfono del Customer
customer.government_id
Identificador personal del Customer según su nacionalidad
flow_name
Nombre del flow con el cual se creó la Checkout Session.
url
Url que dirige directamente a la sesión de pago
state
Estado de la Checkout Session, puede ser open, expired y completed
id_organization
Identificador único de la organización
expiration_datetime
Fecha y hora en formato ISO en la cual la Checkout Session expirará
mode
Modo de la Checkout Session. Puede ser PAYMENT, ENROLLMENTy SAVE_PAYMENT_INSTRUMENT
payment_options_configuration
Configuraciones predefinidas para el proceso de checkout.
payment_options_configuration.card
Configuraciones para el formulario de tarjetas.
payment_options_configuration.transfer_cl
Configuraciones para el formulario de transferencias Chile.
form_information
Infomación no sensible con la cual el usuario relleno el formulario
external_id
Identificador entregado por la organización para poder identificar las transacciones o inscripciones realizadas con una checkout session.
additional_query_parameters
Parámetros adicionales para agregar en la url de una Checkout Session.
legacy_creation_parameters
Parámetros adicionales utilizados por antiguas checkout sessions.
transactions
Listado con las transacciones asociadas a una Checkout Session. Estos corresponden a objetos de Transaction
payment_methods
Listado con los payment methods asociados a un Checkout Session. Estos corresponden a objetos Payment Method
payment_instrument
Objeto Payment instrument asociado a una Checkout Session
Ejemplo
{
"id": "abcd-1234-efgh-5678",
"billing_data": {
"amount": 150.50,
"currency": "MXN",
"ids_invoice": [
"inv_abc123def456",
"inv_xyz789uvw012"
],
"id_subscription": "sub_9876543210fedcba",
"payment_engine": "saas",
"payment_frequency": "onetime",
"account": {
"id": "acc_111222333444",
"name": "Main Account",
"is_main": true
},
"customer": {
"id": "cust_555666777888",
"name": "John Doe",
"email": "[email protected]",
"external_id": "ext_customer_123",
"phone_number": "+525512345678",
"government_id": "ABCD123456EFG"
}
},
"flow_name": "payment_flow_v2",
"url": "https://client-portal.toku.com/checkout?checkoutSession=cs_1234567890abcdef&accessSource=web&redirection=success_url",
"state": "open",
"expiration_datetime": "2025-12-31T23:59:59Z",
"mode": "PAYMENT",
"id_organization": "org_999888777666",
"payment_options_configuration": {
"card": {
"installments_configuration": {
"max_installments": 12,
"min_installment_amount": 100.0
},
"enable_toggle_switch": true,
"id_orchestration_tree": "orch_tree_12345"
},
"transfer_cl": {
"available_institutions": [
"banco_chile",
"banco_santander",
"banco_bci"
]
},
"pac": {
"mandate_id": "mandate_abc123"
}
},
"form_information": {
"selected_installments": 3,
"customer_preferences": {
"language": "es",
"currency_preference": "MXN"
}
},
"external_id": "ext_checkout_789",
"additional_query_parameters": {
"redirection": "https://merchant.com/success",
"access_source": "web"
},
"transactions": [
{
"id": "txn_aaa111bbb222",
"type": "PAYMENT",
"amount": "150.50",
"currency": "MXN",
"transaction_date": "2025-01-15T10:30:00Z",
"status": "COMPLETED",
"transaction_metadata": {
"gateway_response": "approved",
"authorization_code": "AUTH123456"
},
"response_code": "00",
"voucher": null,
"id_checkout_session": "abcd-1234-efgh-5678",
"external_id": "ext_txn_001",
"id_payout": "payout_xyz789",
"additional_data": {},
"original_response_message": "Transaction approved"
}
],
"payment_methods": [
{
"id": "pm_card_123456",
"customer": "cust_555666777888",
"gateway": "cde_payment_orchestration",
"card_type": "VISA",
"card_number": "****1234",
"status": "CHARGEABLE",
"additional_data": {
"holder_id": "holder_123",
"account_type": "credit",
"account_number": null,
"institution_id": null,
"institution_name": null,
"institution_country": null,
"limit_uf": null,
"mandate_id": null,
"voucher_url": null,
"voucher": null
},
"product_ids": ["prod_001", "prod_002"],
"id_account": "acc_111222333444"
}
],
"payment_instrument": {
"country": "MX",
"version": "v2",
"type": "card",
"id": "pi_card_789012",
"id_checkout_session": "abcd-1234-efgh-5678",
"card": {
"bin": "411111",
"last_digits": "1234",
"cardholder_name": "JOHN DOE",
"expiration_month": 12,
"expiration_year": 2025,
"brand": "VISA"
}
}
}