Un checkout permite que tus clientes paguen utilizando alguno de los métodos de pagos habilitados en tu cuenta, tales como un Pago, Pago en Cuotas, 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.
Este es el principal objeto a la hora de crear una intención de pago que no sea recurrente.
El objeto checkout
checkout| Atributo | Tipo | Descripción |
|---|---|---|
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) |
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 false. |
cancel_url | string | Una URL a la cual el cliente será redirigido si la autorización del pago falla. |
cancel_url_method | string | El método HTTP a utilizar al redirigir al cliente en caso de un pago fallido. Uno de post, get.Default es post. |
currency | string | Código de moneda ISO de tres letras. Corresponde a la moneda de presentación. |
customer | objectampliable | Objeto customer relacionado. |
customer_id | string | ID customer relacionado. |
description | string | Un texto arbitrario asociado al objeto. |
live | boolean | Indica si el pago 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. |
source | string | Indica qué sistema o plataforma fue responsable de crear el pago. Uno de shopify, vtex, jumpseller. |
status | string | El estado del pago. Uno de paid, unpaid, canceled. |
status_reason | string | Incluye detalles sobre un pago fallido o cancelado. |
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. Uno de post, get. Default es post. |
successful_object | string | Indica el tipo de objeto creado en caso de un pago exitoso. Esto depende del método de pago elegido por el cliente. Uno de payment, loan_intent. |
url | string | Una URL utilizada para identificar de forma exclusiva el objeto. Las URL se pueden usar para compartir un pago en aplicaciones de mensajería, códigos QR y otros canales. |
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. |
Estados
| Estado | Descripción |
|---|---|
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. |