Crear una Suscription

POST /v3/suscription

Ambiente	URL base API	Portal de comercio
Sandbox	`https://api.virtualpos-sandbox.com`	comercios.virtualpos-sandbox.com
Producción	`https://api.virtualpos.cl`	comercios.virtualpos.cl

Headers

Nombre	Tipo	Requerido	Descripción
`Authorization`	string	Sí	API KEY del comercio
`Signature`	string	Sí	Firma del mensaje

Body

Campo	Tipo	Requerido	Descripción
`email`	string	Sí	Correo electrónico del cliente
`social_id`	string	Sí	Rut del cliente, Tipo: Rut válido sin puntos ni guion
`first_name`	string	Sí	Nombre del cliente
`last_name`	string	Sí	Apellido del cliente
`phone_number`	string	Sí	Número teléfonico del cliente
`plan_id`	string	Sí	Identificador del plan a suscribir
`return_url`	string	Sí	URL a la cual será redirigido el suscriptor una vez finalizado el flujo de suscripción. La URL debe ser codificada en Base64
`callback_url`	string	Sí	URL a la cual se realizará un callback Asincrono una vez que se haya finalizado el proceso de inscripción en VirtualPOS. Debe estar codificada Base64
`channel`	string	No	Identificador del canal utilizado por el comercio para generar la suscripción, útil para realizar trazabilidad.
`service_id`	string	No	Identificador del comercio, útil para realizar trazabilidad.
`seller_id`	string	No	Rut del vendedor Por defecto: `123123321-3`.
`charges_program`	array	No	Parámetro obligatorio para planes del tipo “PROGRAMA DE PAGOS”, El formato del parámetro debe ser un array JSON con un listado de objetos con la fecha del cargo (charge_date) y el monto (amount). El parámetro charges_program debe ser codificada en Base64.
`charges_program[].amount`	number (float)	Sí	Monto del cobro que se desea programar
`charges_program[].charge_date`	string	Sí	Fecha que se desea realizar el cargo, Tipo: date yyyy-mm-dd, ejemplo: 2021-09-30
`charges_program[].description`	string	Sí	Detalle descriptivo asociado al cargo que se realizará
`charges_program[].internal_code`	string	No	Identificador del comercio, útil para identificar y dar trazabilidad al cobro.

Ejemplo de request

curl -X POST 'https://api.virtualpos-sandbox.com/v3/suscription' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $API_KEY" \
  -H "Signature: $SIGNATURE" \
  -d '{
  "email": "<email>",
  "social_id": "<social_id>",
  "first_name": "<first_name>",
  "last_name": "<last_name>",
  "phone_number": "<phone_number>",
  "plan_id": "<plan_id>",
  "return_url": "<return_url>",
  "callback_url": "<callback_url>",
  "channel": "<channel>",
  "service_id": "<service_id>",
  "seller_id": "123123321-3",
  "charges_program": [
    {
      "amount": 0,
      "charge_date": "<charge_date>",
      "description": "<description>",
      "internal_code": "<internal_code>"
    }
  ]
}'

Respuestas

200 OK

{
  "status": "OK",
  "code": 200,
  "url_redirect": "https://pat.virtualpos.cl/suscripcion-integrada/3a4d77f2e4",
  "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": "F"
    },
    "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": "user@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "social_id": "12345678-9",
      "phone": "56961934502",
      "gender": {
        "id": 1,
        "name": "Masculino"
      },
      "birth_date": "1992-10-20"
    }
  }
}

400 Bad Request

{}