Ir al contenido

Crear un Client

Permite crear un nuevo cliente asociado al comercio autenticado.

POST /v3/client
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
Nombre Tipo Requerido Descripción
Content-Type string No
Authorization string Sí API KEY del comercio
Signature string Sí Firma del mensaje
Campo Tipo Requerido Descripción
type string Sí PERSONA o EMPRESA Valores: 'PERSONA', 'EMPRESA'.
social_id string No Número de documento asociado a social_id_type. Debe ser único.
first_name string Sí Nombre del cliente (o razón social si es type = EMPRESA)
last_name string No Obligatorio cuando es type = PERSONA. Opcional para EMPRESA
email string Sí Email del cliente. Debe ser único y con formato válido
phone string No Teléfono del cliente.
social_id_type string No 1 si es RUT o 2 si es DNI. Si es RUT se valida el formato.
birth_date string No Fecha de nacimiento YYYY-MMDD
gender_id string No 1 para Masculino, 2 Femenino o 4 para Otro Valores: 'Masculino', 'Femenino', 'Otro'.
private_note string No Nota interna del comercio.
Ventana de terminal
curl -X POST 'https://api.virtualpos-sandbox.com/v3/client' \
-H 'Content-Type: application/json' \
-H "Authorization: $API_KEY" \
-H "Signature: $SIGNATURE" \
-d '{
"type": "'\''PERSONA'\''",
"social_id": "<social_id>",
"first_name": "<first_name>",
"last_name": "<last_name>",
"email": "<email>",
"phone": "<phone>",
"social_id_type": "<social_id_type>",
"birth_date": "<birth_date>",
"gender_id": "'\''Masculino'\''",
"private_note": "<private_note>"
}'
{
"client": {
"uuid": "cli_00183af742e91dc3",
"status": "ACTIVO",
"type": "PERSONA",
"first_name": "John",
"last_name": "Doe",
"email": "user@example.com",
"phone_number": "56961934502",
"social_id_type": "RUT",
"social_id": "12345678-9",
"birth_date": "1990-01-01",
"gender_id": "Masculino",
"private_note": "Cliente recurrente de suscripciones de seguros.",
"created": "2025-01-08 11:20:31",
"updated": "2025-01-08 11:20:31"
}
}
{
"status": "NOK",
"code": 400,
"error": {
"error_code": "E-###",
"message": "detalle del error",
"doc_url": "https://virtualpos.readme.io/reference/objeto-error"
}
}