Un objeto SetupIntent representa una intención de inscripción de un método de pago por parte de un cliente.
El objeto SetupIntent
SetupIntentAtributos
id string
Identificador único del objeto.
object string
Indica el tipo de objeto. Valor siempre será setup_intent.
status enum
El estado del objeto.
| Posibles valores | Descripción |
|---|---|
pending | Estado inicial del objeto. Significa que el cliente podrá registrar su tarjeta. |
succeeded | La tarjeta fue registrada satisfactoriamente. |
canceled | El objeto fue cancelado y ya no está disponible para registrar una tarjeta. |
expired | El objeto expiró dado que tiene un límite de tiempo para poder registrar la tarjeta. |
customer_id string
ID objeto Customer relacionado.
payment_method_id string
ID objeto PaymentMethod inscrito. Se completa únicamente cuando el estado es succeeded.
url string
Una URL utilizada para redirigir al cliente para que este inscriba un método de pago.
success_url string
Una URL a la cual el cliente será redirigido al inscribir un método de pago exitosamente.
success_url_method enum
El método HTTP a utilizar al redirigir al cliente tras una inscripción exitosa.
| Posibles valores |
|---|
post default |
get |
cancel_url string
Una URL a la cual el cliente será redirigido para volver al comercio si cancela la inscripción.
cancel_url_method enum
El método HTTP a utilizar al redirigir al cliente en caso de cancelación.
| Posibles valores |
|---|
post default |
get |
valid_until datetime
Fecha de expiración del campo url en formato ISO 8601. En huso horario UTC.
session_id string
ID objeto Session relacionado.
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.
live boolean
Indica si el objeto existe en modo live o modo test.
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.

