Log In

El objeto Suscription representa el acuerdo entre el comercio y el cliente cuando se realiza la adherencia a un plan, y contiene los atributos necesarios para generar la recurrencia de los cobros, entre ellos el medio de pago .

{
   "suscription":{
      "status":"ACTIVA",
      "id":"3a4d77f2e4",
      "plan_id":"fd53ead26f78b56113312609b668411b",
      "plan_name":"Plan mensual",
      "suscription_date":"2021-09-08 11:20:31",
      "payment_method":{
         "bin":"405188",
         "issuer":"Banco de Chile",
         "last4CardDigit":"6623",
         "brand":"VISA",
         "expiration_date":"12/27",
         "card_on_file":"T"
      },
      "currency":"CLP",
      "amount":9990,
      "automatic_renewal":"F",
      "channel":"WEB",
      "service_id":"12312312-3",
      "charge_program":[
         {
            "id":"cid_2566645567e51ef2b7.76832273",
            "charge_date":"2023-05-01",
            "amount":"6990",
            "status":"pagado",
            "description":"Cargo 1 de 3"
         },
         {
            "id":"cid_2566645567e51ef2b7.76832274",
            "charge_date":"2023-06-01",
            "amount":"6990",
            "status":"pendiente",
            "description":"Cargo 2 de 3"
         },
         {
            "id":"cid_2566645567e51ef2b7.76832275",
            "charge_date":"2023-07-01",
            "amount":"6990",
            "status":"pendiente",
            "description":"Cargo 3 de 3"
         }
      ],
      "client":{
         "email":"[email protected]",
         "first_name":"John",
         "last_name":"Doe",
         "social_id":"12345678-9",
         "phone":"56961934502"
      }
   }
}

El objeto Suscription puede tener los siguientes estados dependiendo de la etapa en la que se encuentre:

STATUSDESCRIPTION
SUSCRIBIENDOEstado inicial, en espera de que el cliente termine el flujo de suscripción.
SUSCRIPCION_FALLIDAEstado final, indica que finalizó el flujo de suscripción sin que el cliente pudiera inscribir un medio de pago.
ACTIVAEstado final, finalizó el flujo de suscripción de forma exitosa, el cliente inscribió un medio de pago válido.
CANCELADAEstado final, indica que la suscripción fue detenida y no se procesaran los cargos futuros que estaban programados.
FINALIZADAHa superado el tiempo máximo de espera del intento de suscripción. Default 30 días.

Atributos del objeto Suscription:

AttributeTypeDescription
idstringCódigo único que representa la suscripción a un plan en VirtualPOS. Se recomienda almacenar para posteriormente consultar el resultado.
statusenumEstado de la suscripción. El listado de valores posibles es el siguiente (ver tabla STATUS) :
  • SUSCRIBIENDO
  • ACTIVA
  • SUSCRIPCION_FALLIDA
  • CANCELADA
  • FINALIZADA
  • plan_idstringIdentificador del plan del comercio.
    plan_namestringNombre del plan del comercio.
    suscription_datedateFecha de creación de la suscripción Formato: yyyy-mm-dd hh:mm:ss
    payment_methodobjectMedio de pago asociado a la suscripción.
    currencyenumMoneda utilizada para efectuar los cobros. Valores posibles :
  • CLP
  • UF
  • amountnumericMonto utilizado para programar los cobros recurrentes.
    automatic_renewalenumIndicador de renovación automática de la suscripción. Valores posibles :
  • F
  • T
  • channelstringCanal utilizado por el comercio para iniciar el proceso de suscripción.
    service_idstringParámetro informado por el comercio para asociarlo a la suscripción.
    charge_programobject arrayListado de objetos con la programación de los cobros.
    clientobjectCliente asociado a la suscripción

    Objeto payment_method

    AttributeTypeDescription
    binintegerNumero de identificación del emisor del medio de pago.
    issuerstringNombre del emisor del medio de pago.
    last4CardDigitinteger4 últimos dígitos del medio de pago.
    brandstringMarca del medio de pago, ejemplo: Visa, Mastercard, Amex.
    expiration_datestringFecha de expiración del método de pago
    card_on_fileenumParámetro que indica si el método de pago es tokenizado y almacenado en la bóveda de VirtualPOS . Valores posibles :
  • F
  • T
  • Objeto charge_program

    AttributeTypeDescription
    idstringIdentificador unico del cobro.
    charge_datedateFecha de la programación del cobro, formato : yyyy-mm-dd
    amountnumericMonto del cobro.
    statusenumEstado del cobro. El listado de valores posibles es el siguiente :
  • pendiente
  • pagado
  • cancelado
  • procesando
  • rechazado
  • descriptionstringDescripción del cobro, ejemplo: Cargo 1 de 12

    objeto client

    AttributeTypeDescription
    emailemailCorreo del cliente asociado a la suscripción
    first_namestringNombre del cliente.
    last_namestringApellido del cliente.
    social_idstringRut del cliente.
    phonestringTelefono del cliente.