Un objeto checkout permite que tus clientes paguen utilizando alguno de los métodos de pagos habilitados en tu cuenta, tales como 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.
El objeto checkout
checkoutAtributos
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 cargo 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 cargo falla o es cancelada por el cliente.
cancel_url_method enum
El método HTTP a utilizar al redirigir al cliente en caso de una autorización fallida.
| Posibles valores |
|---|
post default |
get |
canceled_at datetime
Fecha de cancelación del objeto en formato ISO 8601. En huso horario UTC.
currency string
Código de moneda ISO de tres letras. Corresponde a la moneda de presentación.
customer_id string
ID objeto customer relacionado.
customer object expandible
Objeto 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.
installments_plan object
Plan de pago en cuotas, si es que fue aplicado al autorizar el cargo. No está disponible para pagos de tipo BNPL.
items array of objects
Listado de productos o servicios que componen el objeto. El monto a autorizar (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:
| Atributo | Tipo | Descripción |
|---|---|---|
| unit_price requerido | integer | Precio unitario del item. Sigue las mismas reglas de monto y moneda de la API. |
| quantity requerido | integer | Cantidad del item. Se multiplica por unit_price para determinar el monto total del ítem. |
| name opcional | string | Descripción del ítem. |
| sku opcional | string | SKU del ítem. |
live boolean
Indica si el objeto 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.
original_amount integer
Monto original del objeto antes de aplicar descuentos.
paid_at datetime
Fecha de autorización en formato ISO 8601. En huso horario UTC.
payment_button_id string
ID objeto payment_button relacionado.
payment_button string expandible
Objeto payment_button relacionado.
payment_method_id string
ID objeto payment_method relacionado.
payment_method object expandible
Objeto payment_method relacionado.
payout_id string
ID objeto payout relacionado.
refunded boolean
Indica si el objeto ha sido reembolsado o no.
refunded_at datetime
Fecha del último reembolso aplicado en formato ISO 8601. En huso horario UTC.
refunded_amount integer
Monto reembolsado representado en la unidad monetaria más pequeña. Puede ser inferior a la cantidad si el pago se reembolsa parcialmente.
session object
Sesión del usuario al momento de autorizar el cargo. Indica dirección IP, User Agent y ubicación geográfica si es que está disponible.
settlement_amount integer
Un número entero positivo que representa el monto autorizado en la moneda de settlement del comercio.
settlement_currency string
Código de moneda ISO de tres letras. Corresponde a la moneda de settlement del comercio.
source string
Indica qué sistema o plataforma fue responsable de crear el objeto.
Uno de shopify, vtext, jumpseller
status enum
El estado del objeto.
| Posibles valores | Descripción |
|---|---|
unpaid | Estado inicial del objeto. Significa que el cliente podrá elegir uno de los métodos de pago habilitados en tu cuenta para pagar. |
paid | El objeto fue autorizado exitosamente a través de uno de los métodos de pago habilitados en tu cuenta. |
canceled | El objeto fue cancelado y ya está no está disponible para ser autorizado. |
subtotal integer
Monto antes de aplicar impuestos.
success_url string
Una URL a la cual el cliente será redirigido si la autorización del cargo es exitosa.
success_url_method string
El método HTTP a utilizar al redirigir al cliente si la autorización del cargo es exitosa.
| Posibles valores |
|---|
post default |
get |
successful_object string
Tipo de transacción en caso de que exista una autorización exitosa.
Uno de payment, loan_intent (BNPL).
url string
Una URL utilizada para identificar de forma exclusiva el objeto. Las URL se pueden usar para compartir el objeto 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. En huso horario UTC.
updated_at datetime
Fecha de actualización del objeto en formato ISO 8601. En huso horario UTC.