Un checkout permite que tus clientes paguen utilizando alguno de los métodos de pagos habilitados en tu cuenta, tales como un Pago con Tarjetas, Transferencia Electrónica, etc.

Usualmente se utiliza este objeto para que tus clientes paguen por productos elegidos en el carro de compras de tu tienda o ecommerce.

Este es el principal objeto a la hora de crear una intención de pago que no sea recurrente.

El objeto checkout

Atributos


id string

Identificador único del objeto.


object string

Indica el tipo de objeto. Valor siempre será checkout.


amount integer

Un número entero positivo que representa cuánto cobrar en la unidad monetaria más pequeña (por ejemplo, 100 centavos para cobrar USD $ 1,00 o 100 para cobrar CLP $ 100).

Se determina según los productos/ítems asociados.


authorize boolean

Indica si el pago se capturará/autorizará inmediatamente después de la autorización/aprobación según el método de pago elegido por el cliente.

Default es true.


available_for_refund integer

Monto disponible para reembolsar.

Siempre será menor o igual al monto total.


cancel_url string

Una URL a la cual el cliente será redirigido si la autorización del pago falla o es cancelada por el cliente.


cancel_url_method enum

El método HTTP a utilizar al redirigir al cliente en caso de un pago fallido.

Posibles valores
post default
get

canceled_at datetime

Fecha de cancelación de la orden en formato ISO 8601. Basado en UTC.


currency string

Código de moneda ISO de tres letras. Corresponde a la moneda de presentación.


customer object ampliable

Objeto customer relacionado.


customer_id string

ID customer relacionado.


description string

Un texto arbitrario asociado al objeto.


discount amount

Monto total de los descuentos aplicados.


external_id string

Referencia a ID de sistema externo. Si el registro proviene de Shopify se completa con el Payment Session ID, si proviene de VTEX con el Payment ID.


fee integer

Comisión cobrada por VentiPay en la moneda de settlement.


items array of objects

Listado de productos o servicios que componen la orden. El monto a cobrar (amount) se determina a partir de los elementos de este listado, en particular desde la cantidad y precio de cada uno.

Cada elemento del array tiene la siguiente estructura:

AtributoTipoDescripción
unit_price requeridointegerPrecio unitario del item. Sigue las mismas reglas de monto y moneda de la API.
quantity requeridointegerCantidad del item. Se multiplica por unit_price para determinar el monto total del ítem.
name opcionalstringDescripción del ítem.
sku opcionalstringSKU del ítem.

live boolean

Indica si la orden existe en modo live o modo test.


metadata object

Conjunto de pares llave-valor que puedes asociar a un objeto.
Esto puede resultar útil para almacenar información adicional sobre el objeto en un formato estructurado.


payment_method object ampliable

Objeto payment_method relacionado.


payment_method_id string

ID payment_method relacionado.

original_amount integer

Monto original de la compra antes de aplicar descuentos.


source string

Indica qué sistema o plataforma fue responsable de crear la orden.

Uno de shopify, vtext, jumpseller


status enum

El estado de la orden.

Posibles valores
unpaid

Estado inicial del pago. Significa que el cliente podrá elegir uno de los métodos de pago habilitados en tu cuenta para pagar.
paid

El pago fue completado y tiene un pago exitoso a través de uno de los métodos de pago habilitados en tu cuenta.
canceled

El pago fue cancelado y ya está no está disponible para ser pagado.

subtotal integer

Monto antes de aplicar impuestos.


success_url string

Una URL a la cual el cliente será redirigido si la autorización del pago es exitosa.


success_url_method string

El método HTTP a utilizar al redirigir al cliente en caso de un pago exitoso.

Posibles valores
post default
get

successful_object string

Tipo de transacción en caso de que exista un pago exitoso asociado.

Uno de payment, loan_intent.


url string

Una URL utilizada para identificar de forma exclusiva el objeto. Las URL se pueden usar para compartir una orden en aplicaciones de mensajería, códigos QR y otros canales.


tax integer

Monto total de los impuestos aplicados.


created_at datetime

Fecha de creación del objeto en formato ISO 8601. Basado en UTC.


updated_at datetime

Fecha de actualización del objeto en formato ISO 8601. Basado en UTC.