Cancelar el envío al POS

Retira del POS una suscripción que enviaste y que tu cliente aún no completa, por ejemplo si el cliente se retiró o enviaste la suscripción al equipo equivocado. Así el POS queda libre para atender otra suscripción.

POST /v3/suscription/push-to-terminal/cancel

Ambiente	URL base API
Integración	Te la entrega tu ejecutivo. Ver Ambientes y credenciales.
Producción	https://api.virtualpos.cl

Headers

Nombre	Tipo	Requerido	Descripción
Content-Type	string	Sí	application/json
Authorization	string	Sí	API KEY del comercio
Signature	string	Sí	JWT HS256 firmado con tu SECRET KEY, payload {"api_key": "<tu API KEY>"}. Ver Autenticación y firma.

Body

Campo	Tipo	Requerido	Descripción
terminal_serial_number	string	Sí	Número de serie del POS al que enviaste la suscripción.
suscription_uuid	string	Sí	id de la suscripción enviada.
forced_by	string	Sí	Quién solicita la cancelación, por ejemplo el nombre del usuario o del área.
reason	string	No	Motivo de la cancelación.

Ejemplo de request

curl -X POST "$URL_BASE/v3/suscription/push-to-terminal/cancel" \
  -H 'Content-Type: application/json' \
  -H "Authorization: $API_KEY" \
  -H "Signature: $SIGNATURE" \
  -d '{
  "terminal_serial_number": "VPOS-1A2B3C4D5E",
  "suscription_uuid": "3a4d77f2e4",
  "forced_by": "operaciones",
  "reason": "El cliente se retiró sin presentar su tarjeta"
}'

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

{}