Crear un Plan

Permite crear un plan

POST /v3/plan

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
name	string	Sí	Nombre del plan recurrente
description	string	Sí	Descripción del plan recurrente
type	string	No	Tipo de plan Valores: MONTO_FIJO, MONTO_VARIABLE, PROGRAMA_DE_PAGOS.
currency	string	Sí	Moneda utilizada Valores: CLP, UF.
amount	number (float)	No	Monto fijo
trial_days	integer (int32)	No
num_charges	integer (int32)	No
frequency_type	string	No	Frecuencia de los cobros Valores: Diario, Semanal, Mensual.
fixed_amount_day_charge	string	No	Valores: 0, 01, 05, 10, 15, 20, 25, 28, 30.
return_url	string	No	URL de su aplicación a la cual se retornará una vez que se haya finalizado la suscripción. En esta URL se deberá ejecutar la consulta del resultado de suscripción, ya que por motivos de seguridad la respuesta no se entrega en forma directa a la URL de retorno
automatic_renewal	string	No	Flag de renovación automática. Valores: T, F. Por defecto: F.
show_in_terminal	string	No	Flag para visualización en SmartPOS Valores: T, F. Por defecto: F.
shipping_address	string	No	Flag para indicar que requiere direcciones de despacho. Valores: "T", "F".

Ejemplo de request

curl -X POST 'https://api.virtualpos-sandbox.com/v3/plan' \
  -H 'Content-Type: application/json' \
  -H "Authorization: $API_KEY" \
  -H "Signature: $SIGNATURE" \
  -d '{
  "name": "<name>",
  "description": "<description>",
  "type": "MONTO_FIJO",
  "currency": "CLP",
  "amount": 0,
  "trial_days": 0,
  "num_charges": 0,
  "frequency_type": "Diario",
  "fixed_amount_day_charge": "0",
  "return_url": "<return_url>",
  "automatic_renewal": "F",
  "show_in_terminal": "F",
  "shipping_address": "\"T\""
}'

Respuestas

200 OK

{
  "status": "OK",
  "code": 200,
  "plan": {
    "id": "fd53ead26f78b56113312609b668411b",
    "name": "Seguro automotriz",
    "description": "Asegura tu vehiculo",
    "is_active": "T",
    "amount": 9990,
    "currency": "CLP",
    "trial_days": 0,
    "num_charges": 12,
    "frequency_type": "Mensual",
    "return_url": "https://www.misitio.com",
    "suscription_url": "https://pat.virtualpos.cl/suscripcion/acme-corp/31a2b726a23ff92487984ba17e0b7258",
    "type": "MONTO_FIJO",
    "fixed_amount_day_charge": "05",
    "automatic_renewal": "T",
    "show_in_terminal": "F",
    "created_at": "2023-05-15 23:15:00",
    "shipping_address": "F"
  }
}

400 Bad Request

{}