Objeto Subscription intent

El objeto Subscription Intent

Un SubscriptionIntent representa el intento de inscribir la cuenta bancaria de un usuario final para débito directo. El campo status indica el progreso de la inscripción. Una inscripción exitosa crea la Subscription que referencia el campo subscription.

Para integraciones existentes que solo inscriben cuentas bajo tu propio convenio bancario, usa subscription_intent.succeeded para confirmar una inscripción completada. Una inscripción exitosa no confirma la activación del mandato ni la disponibilidad para cobrar en tu banco. No uses el status de la Subscription que recibes ni sus webhooks de ciclo de vida como señales del estado bancario. Consulta Inscripción bajo tu propio convenio bancario.

El siguiente ejemplo muestra un SubscriptionIntent:

{
  "id": "si_m7N9rAWJS9dWDKEe",
  "object": "subscription_intent",
  "business_profile": {
    "name": "Merchant Name"
  },
  "created_at": "2021-11-11T02:29:16Z",
  "customer_email": "customer@example.com",
  "mode": "live",
  "public_error": null,
  "reference_id": null,
  "status": "created",
  "subscription": null,
  "widget_token": "si_m7N9rAWJS9dWDKEe_sec_1y7o6DYLY299p7ePP7zevTEj"
}

El SubscriptionIntent tiene los siguientes atributos:

Atributo	Tipo	Descripción
`id`	`string`	Identificador único del `SubscriptionIntent`.
`object`	`string`	Tipo de objeto. Siempre es `subscription_intent`.
`business_profile`	`object` o `null`	Perfil del comercio inscrito, con los campos descritos en la tabla del objeto Business Profile. El widget muestra el nombre como “Empresa destinataria”. Devuelve `null` cuando no se define un nombre de comercio.
`created_at`	`string`	Fecha de creación como fecha y hora ISO 8601 en UTC.
`customer_email`	`string` o `null`	Email del cliente asociado al `SubscriptionIntent`. `null` cuando no se define un email.
`mode`	`string`	Entorno del `SubscriptionIntent`. Puede ser `live` o `test`. El modo `test` usa el sandbox.
`public_error`	`string` o `null`	Código de error que explica por qué falló la inscripción. Consulta Subscription intent public errors para ver la lista completa. Devuelve `null` cuando no hay un error público disponible.
`reference_id`	`string` o `null`	Identificador proporcionado por el comercio que determina cómo el banco identifica la suscripción en su portal. Si no se proporciona, usa el `holder_id` de la cuenta. Solo está disponible para clientes de Subscriptions y admite entre 1 y 15 caracteres.
`status`	`string`	Estado actual de la inscripción. Puede ser `created`, `in_progress`, `succeeded`, `failed` o `rejected`.
`subscription`	`object` o `null`	`Subscription` creada después de una inscripción exitosa. Devuelve `null` si la inscripción no tiene éxito.
`widget_token`	`string` o `null`	Token temporal para configurar el widget. Solo se devuelve al crear el `SubscriptionIntent`. Las respuestas posteriores devuelven `null`.

El objeto Business Profile (dentro del objeto Subscription Intent)

El campo business_profile contiene el siguiente atributo del objeto Business Profile para el comercio inscrito:

Atributo	Tipo	Descripción
`name`	`string`	Nombre del comercio inscrito. El widget lo muestra como “Empresa destinataria”.

​El objeto Subscription Intent

​El objeto Business Profile (dentro del objeto Subscription Intent)

El objeto Subscription Intent

El objeto Business Profile (dentro del objeto Subscription Intent)